Module java.desktop
Package javax.swing.colorchooser

Class AbstractColorChooserPanel

  • All Implemented Interfaces:
    ImageObserver, MenuContainer, Serializable, Accessible
    public abstract class AbstractColorChooserPanel
extends JPanel
    This is the abstract superclass for color choosers. If you want to add a new color chooser panel into a JColorChooser, subclass this class.

    Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans™ has been added to the java.beans package. Please see XMLEncoder.

    See Also:
    Serialized Form

    • Field Detail

      • TRANSPARENCY_ENABLED_PROPERTY

        public static final String TRANSPARENCY_ENABLED_PROPERTY
        Identifies that the transparency of the color (alpha value) can be selected
        See Also:
        Constant Field Values

    • Constructor Detail

      • AbstractColorChooserPanel

        public AbstractColorChooserPanel()

    • Method Detail

      • updateChooser

        public abstract void updateChooser()
        Invoked automatically when the model's state changes. It is also called by installChooserPanel to allow you to set up the initial state of your chooser. Override this method to update your ChooserPanel.

      • buildChooser

        protected abstract void buildChooser()
        Builds a new chooser panel.

      • getDisplayName

        public abstract String getDisplayName()
        Returns a string containing the display name of the panel.
        Returns:
        the name of the display panel

      • getMnemonic

        public int getMnemonic()
        Provides a hint to the look and feel as to the KeyEvent.VK constant that can be used as a mnemonic to access the panel. A return value <= 0 indicates there is no mnemonic.

        The return value here is a hint, it is ultimately up to the look and feel to honor the return value in some meaningful way.

        This implementation returns 0, indicating the AbstractColorChooserPanel does not support a mnemonic, subclasses wishing a mnemonic will need to override this.

        Returns:
        KeyEvent.VK constant identifying the mnemonic; <= 0 for no mnemonic
        Since:
        1.4
        See Also:
        getDisplayedMnemonicIndex()

      • getDisplayedMnemonicIndex

        public int getDisplayedMnemonicIndex()
        Provides a hint to the look and feel as to the index of the character in getDisplayName that should be visually identified as the mnemonic. The look and feel should only use this if getMnemonic returns a value > 0.

        The return value here is a hint, it is ultimately up to the look and feel to honor the return value in some meaningful way. For example, a look and feel may wish to render each AbstractColorChooserPanel in a JTabbedPane, and further use this return value to underline a character in the getDisplayName.

        This implementation returns -1, indicating the AbstractColorChooserPanel does not support a mnemonic, subclasses wishing a mnemonic will need to override this.

        Returns:
        Character index to render mnemonic for; -1 to provide no visual identifier for this panel.
        Since:
        1.4
        See Also:
        getMnemonic()

      • getSmallDisplayIcon

        public abstract Icon getSmallDisplayIcon()
        Returns the small display icon for the panel.
        Returns:
        the small display icon

      • getLargeDisplayIcon

        public abstract Icon getLargeDisplayIcon()
        Returns the large display icon for the panel.
        Returns:
        the large display icon

      • installChooserPanel

        public void installChooserPanel​(JColorChooser enclosingChooser)
        Invoked when the panel is added to the chooser. If you override this, be sure to call super.
        Parameters:
        enclosingChooser - the chooser to which the panel is to be added
        Throws:
        RuntimeException - if the chooser panel has already been installed

      • uninstallChooserPanel

        public void uninstallChooserPanel​(JColorChooser enclosingChooser)
        Invoked when the panel is removed from the chooser. If override this, be sure to call super.
        Parameters:
        enclosingChooser - the chooser from which the panel is to be removed

      • getColorSelectionModel

        public ColorSelectionModel getColorSelectionModel()
        Returns the model that the chooser panel is editing.
        Returns:
        the ColorSelectionModel model this panel is editing

      • getColorFromModel

        protected Color getColorFromModel()
        Returns the color that is currently selected.
        Returns:
        the Color that is selected

      • setColorTransparencySelectionEnabled

        @BeanProperty(description="Sets the transparency of a color selection on or off.")
public void setColorTransparencySelectionEnabled​(boolean b)
        Sets whether color chooser panel allows to select the transparency (alpha value) of a color. This method fires a property-changed event, using the string value of TRANSPARENCY_ENABLED_PROPERTY as the name of the property.

        The value is a hint and may not be applicable to all types of chooser panel.

        The default value is true.

        Parameters:
        b - true if the transparency of a color can be selected
        See Also:
        isColorTransparencySelectionEnabled()

      • isColorTransparencySelectionEnabled

        public boolean isColorTransparencySelectionEnabled()
        Gets whether color chooser panel allows to select the transparency (alpha value) of a color.
        Returns:
        true if the transparency of a color can be selected
        See Also:
        setColorTransparencySelectionEnabled(boolean)