Package org.jcolorbrewer.ui

Class ColorPaletteChooserDialog

  • All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants
    public class ColorPaletteChooserDialog
extends javax.swing.JDialog
    A ColorPaletteChooserDialog shows a dialog window for selecting a color palette.
    Author:
    Peter Rose, code adopted from ColorChooserDialog
    See Also:
    ColorChooserDialog, Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class javax.swing.JDialog

        javax.swing.JDialog.AccessibleJDialog

      • Nested classes/interfaces inherited from class java.awt.Dialog

        java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

      • Nested classes/interfaces inherited from class java.awt.Window

        java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

      • Nested classes/interfaces inherited from class java.awt.Container

        java.awt.Container.AccessibleAWTContainer

      • Nested classes/interfaces inherited from class java.awt.Component

        java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected javax.swing.JColorChooser colorChooser
      The style editor panel.
      protected javax.swing.JPanel innerPanel
      The inner panel containing everything.
      protected boolean okWasPressed
      True if OK was pressed; false otherwise.
      protected java.awt.Window parent
      The parent window.
      protected java.awt.Color startingColor
      Starting color, set by setColor, and the color we return to on a reset.
      protected ColorBrewer startingColorBrewer
      Starting color, set by setColor, and the color we return to on a reset.

      • Fields inherited from class javax.swing.JDialog

        accessibleContext, rootPane, rootPaneCheckingEnabled

      • Fields inherited from class java.awt.Dialog

        DEFAULT_MODALITY_TYPE

      • Fields inherited from class java.awt.Component

        BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

      • Fields inherited from interface java.awt.image.ImageObserver

        ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

      • Fields inherited from interface javax.swing.WindowConstants

        DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.awt.Color getColor()
      Get the current color in the color chooser.
      ColorBrewer getColorPalette()
      Get the current color in the color chooser.
      protected void initialize()
      Initializes the GUI for the window.
      static void main​(java.lang.String[] args)  
      void setBackground​(java.awt.Color background)
      Set the background color for the window.
      void setColor​(int red, int green, int blue)
      Set the current color in the color chooser.
      void setColor​(java.awt.Color color)
      Set the current color in the color chooser.
      void setColorBrewer​(ColorBrewer brewer)
      Set the current color in the color chooser.
      void show()
      Show the dialog box.
      boolean showDialog()
      Shows the dialog box and waits for the user to press OK or Cancel.
      boolean wasOKPressed()
      Returns true if the OK button was pressed to close the window, and false otherwise.

      • Methods inherited from class javax.swing.JDialog

        addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

      • Methods inherited from class java.awt.Dialog

        addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, toBack

      • Methods inherited from class java.awt.Window

        addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

      • Methods inherited from class java.awt.Container

        add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

      • Methods inherited from class java.awt.Component

        action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • parent

        protected java.awt.Window parent
        The parent window.

      • innerPanel

        protected javax.swing.JPanel innerPanel
        The inner panel containing everything.

      • colorChooser

        protected javax.swing.JColorChooser colorChooser
        The style editor panel.

      • startingColor

        protected java.awt.Color startingColor
        Starting color, set by setColor, and the color we return to on a reset.

      • startingColorBrewer

        protected ColorBrewer startingColorBrewer
        Starting color, set by setColor, and the color we return to on a reset.

      • okWasPressed

        protected boolean okWasPressed
        True if OK was pressed; false otherwise.

    • Constructor Detail

      • ColorPaletteChooserDialog

        public ColorPaletteChooserDialog()
        Create a non-modal color chooser dialog to select a color.

        This constructor does not require a parent argument to specify a parent window or dialog for this dialog. As a result, this dialog is always non-modal - it does not block interaction with the rest of the application.

      • ColorPaletteChooserDialog

        public ColorPaletteChooserDialog​(java.awt.Frame parent)
        Create a modal color chooser dialog to select a color.
        Parameters:
        parent - the parent frame for this dialog

      • ColorPaletteChooserDialog

        public ColorPaletteChooserDialog​(java.awt.Dialog parent)
        Create a modal color chooser dialog to select a color.
        Parameters:
        parent - the parent dialog for this dialog

    • Method Detail

      • initialize

        protected void initialize()
        Initializes the GUI for the window. That GUI includes a JColorChooser panel, framed with an empty border.

      • show

        public void show()
        Show the dialog box. The dialog is automatically centered on the parent window, or on the screen if there is no parent.

        By default, the dialog box is modal and this method call blocks until the dialog box is closed by the user pressing OK or Cancel. The wasOKPressed() method returns true if OK was pressed.

        Overrides:
        show in class java.awt.Dialog
        See Also:
        wasOKPressed()

      • setBackground

        public void setBackground​(java.awt.Color background)
        Set the background color for the window.
        Overrides:
        setBackground in class java.awt.Dialog
        Parameters:
        background - the new background color

      • showDialog

        public boolean showDialog()
        Shows the dialog box and waits for the user to press OK or Cancel. When either is pressed, the dialog box is hidden. A true is returned if OK was pressed, and false otherwise.

        This method blocks until the dialog is closed by the user, regardless of whether the dialog box is modal or not.

        Returns:
        true if OK was pressed

      • wasOKPressed

        public boolean wasOKPressed()
        Returns true if the OK button was pressed to close the window, and false otherwise.
        Returns:
        true if OK was pressed

      • getColor

        public java.awt.Color getColor()
        Get the current color in the color chooser.
        Returns:
        the current color

      • setColor

        public void setColor​(java.awt.Color color)
        Set the current color in the color chooser.
        Parameters:
        color - the new color

      • setColor

        public void setColor​(int red,
                     int green,
                     int blue)
        Set the current color in the color chooser.
        Parameters:
        red - the red component of the new color
        green - the green component of the new color
        blue - the blue component of the new color

      • getColorPalette

        public ColorBrewer getColorPalette()
        Get the current color in the color chooser.
        Returns:
        the current color

      • setColorBrewer

        public void setColorBrewer​(ColorBrewer brewer)
        Set the current color in the color chooser.
        Parameters:
        color - the new color

      • main

        public static void main​(java.lang.String[] args)