public abstract class

AbstractColorChooserPanel

extends JPanel
java.lang.Object
   ↳ java.awt.Component
     ↳ java.awt.Container
       ↳ javax.swing.JComponent
         ↳ javax.swing.JPanel
           ↳ javax.swing.colorchooser.AbstractColorChooserPanel

Class Overview

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 JavaBeansTM has been added to the java.beans package. Please see XMLEncoder.

Summary

[Expand]
Inherited Constants
From class javax.swing.JComponent
From class java.awt.Component
From interface java.awt.image.ImageObserver
[Expand]
Inherited Fields
From class javax.swing.JComponent
Public Constructors
AbstractColorChooserPanel()
Public Methods
ColorSelectionModel getColorSelectionModel()
Returns the model that the chooser panel is editing.
abstract String getDisplayName()
Returns a string containing the display name of the panel.
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.
abstract Icon getLargeDisplayIcon()
Returns the large display icon for the panel.
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.
abstract Icon getSmallDisplayIcon()
Returns the small display icon for the panel.
void installChooserPanel(JColorChooser enclosingChooser)
Invoked when the panel is added to the chooser.
void paint(Graphics g)
Draws the panel.
void uninstallChooserPanel(JColorChooser enclosingChooser)
Invoked when the panel is removed from the chooser.
abstract void updateChooser()
Invoked automatically when the model's state changes.
Protected Methods
abstract void buildChooser()
Builds a new chooser panel.
Color getColorFromModel()
Returns the color that is currently selected.
[Expand]
Inherited Methods
From class javax.swing.JPanel
From class javax.swing.JComponent
From class java.awt.Container
From class java.awt.Component
From class java.lang.Object
From interface java.awt.MenuContainer
From interface java.awt.image.ImageObserver
From interface javax.accessibility.Accessible

Public Constructors

public AbstractColorChooserPanel ()

Public Methods

public ColorSelectionModel getColorSelectionModel ()

Returns the model that the chooser panel is editing.

Returns
  • the ColorSelectionModel model this panel is editing

public abstract String getDisplayName ()

Returns a string containing the display name of the panel.

Returns
  • the name of the display panel

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.
See Also

public abstract Icon getLargeDisplayIcon ()

Returns the large display icon for the panel.

Returns
  • the large display icon

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

public abstract Icon getSmallDisplayIcon ()

Returns the small display icon for the panel.

Returns
  • the small display icon

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 panel to be added
Throws
RuntimeException if the chooser panel has already been installed

public void paint (Graphics g)

Draws the panel.

Parameters
g the Graphics object

public void uninstallChooserPanel (JColorChooser enclosingChooser)

Invoked when the panel is removed from the chooser. If override this, be sure to call super.

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.

Protected Methods

protected abstract void buildChooser ()

Builds a new chooser panel.

protected Color getColorFromModel ()

Returns the color that is currently selected.

Returns
  • the Color that is selected