javax.swing.colorchooser
Class AbstractColorChooserPanel

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by javax.swing.colorchooser.AbstractColorChooserPanel
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible

public abstract class AbstractColorChooserPanel
extends JPanel

AbstractColorChooserPanel

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JPanel
JPanel.AccessibleJPanel
 
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
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
 
Constructor Summary
AbstractColorChooserPanel()
          This is the constructor for the AbstractColorChooserPanel.
 
Method Summary
protected abstract  void buildChooser()
          This method constructs and does any initialization necessary for the chooser panel.
protected  Color getColorFromModel()
          This method returns the current color stored in the model for this chooser panel.
 ColorSelectionModel getColorSelectionModel()
          This method returns the ColorSelectionModel for the JColorChooser associated with this chooser panel.
 int getDisplayedMnemonicIndex()
          Returns the index of the character in the display name that is the mnemonic.
abstract  String getDisplayName()
          This method returns the name displayed in the tab for this chooser panel.
abstract  Icon getLargeDisplayIcon()
          This method sets the large icon useed in the jTabbedPane for this chooser panel.
 int getMnemonic()
          Returns the key code for the mnemonic for this panel.
abstract  Icon getSmallDisplayIcon()
          This method sets the small icon used in the JTabbedPane for this chooser panel.
 void installChooserPanel(JColorChooser chooser)
          This method installs the chooser panel for the given JColorChooser.
 void paint(Graphics graphics)
          This method paints the chooser panel.
 void uninstallChooserPanel(JColorChooser chooser)
          This method removes the chooser panel from the given JColorChooser and does any necessary clean up for the chooser panel.
abstract  void updateChooser()
          This method updates the chooser panel when the JColorChooser's color has changed.
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setNextFocusableComponent, setOpaque, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AbstractColorChooserPanel

public AbstractColorChooserPanel()
This is the constructor for the AbstractColorChooserPanel.

Method Detail

getDisplayName

public abstract String getDisplayName()
This method returns the name displayed in the tab for this chooser panel.

Returns:
The name displayed in the JTabbedPane's tabs.

getMnemonic

public int getMnemonic()
Returns the key code for the mnemonic for this panel. This method returns zero to indicate no mnemonic, subclasses can override this.

Returns:
0, to indicate no mnemonic key code.
Since:
1.4
See Also:
getDisplayedMnemonicIndex()

getDisplayedMnemonicIndex

public int getDisplayedMnemonicIndex()
Returns the index of the character in the display name that is the mnemonic. This method returns -1 to indicate no mnemonic, subclasses can override.

Returns:
-1, to indicate no mnemonic.
Since:
1.4
See Also:
getDisplayName(), getMnemonic()

updateChooser

public abstract void updateChooser()
This method updates the chooser panel when the JColorChooser's color has changed.


buildChooser

protected abstract void buildChooser()
This method constructs and does any initialization necessary for the chooser panel.


getSmallDisplayIcon

public abstract Icon getSmallDisplayIcon()
This method sets the small icon used in the JTabbedPane for this chooser panel.

Returns:
The small icon used in the JTabbedPane.

getLargeDisplayIcon

public abstract Icon getLargeDisplayIcon()
This method sets the large icon useed in the jTabbedPane for this chooser panel.

Returns:
The large icon.

installChooserPanel

public void installChooserPanel(JColorChooser chooser)
This method installs the chooser panel for the given JColorChooser.

Parameters:
chooser - The JColorChooser that will have this panel installed.

uninstallChooserPanel

public void uninstallChooserPanel(JColorChooser chooser)
This method removes the chooser panel from the given JColorChooser and does any necessary clean up for the chooser panel.

Parameters:
chooser - The JColorChooser that is having this panel removed.

getColorSelectionModel

public ColorSelectionModel getColorSelectionModel()
This method returns the ColorSelectionModel for the JColorChooser associated with this chooser panel.

Returns:
The ColorSelectionModel for the JColorChooser associated with this chooser panel.

getColorFromModel

protected Color getColorFromModel()
This method returns the current color stored in the model for this chooser panel.

Returns:
The current color.

paint

public void paint(Graphics graphics)
This method paints the chooser panel.

Overrides:
paint in class JComponent
Parameters:
graphics - The Graphics object to paint with.
See Also:
JComponent.paintImmediately(Rectangle)