edu.kzoo.grid.gui.nuggets
Class ColorChoiceMenu

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--edu.kzoo.grid.gui.nuggets.ColorChoiceMenu

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

Direct Known Subclasses:

BGColorChoiceMenu

public class ColorChoiceMenu

extends javax.swing.JPanel

Grid GUI Nuggets Package (Handy Grid GUI Components):
A ColorChoiceMenu object provides a drop-down menu for choosing a color.

Version:

29 July 2004

Author:

Alyce Brady (based on code by Julie Zelenski)

See Also:

Serialized Form

Field Summary

protected ColorChoiceDDMenu

colorMenu

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

ColorChoiceMenu(java.lang.String label)
Constructs a menu of color choices.

ColorChoiceMenu(java.lang.String label, ColorChoiceDDMenu.ColorChoice[] colorChoices, ColorChoiceDDMenu.ColorChoice defaultColor)
Constructs a menu of color choices.

ColorChoiceMenu(java.lang.String label, java.lang.String defaultColor)
Constructs a menu of color choices.

Method Summary

void	act() Performs any actions necessary when the color changes.
void	addColorChoice(NamedColor color) Adds a new menu item to the menu with the given color, using its name as the name in the menu.
void	addColorChoice(java.lang.String colorName, java.awt.Color color) Adds a new menu item to the menu with the given name and color.
java.awt.Color	currentColor() Returns the current color from the drop-down menu.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, 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, 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, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

colorMenu

protected ColorChoiceDDMenu colorMenu

Constructor Detail

ColorChoiceMenu

public ColorChoiceMenu(java.lang.String label)

Constructs a menu of color choices. Puts the menu and a label introducing it into a panel. The color choices are those defined in ColorChoiceDDMenu.STANDARD_CHOICES.

Parameters:

label - label for color chooser

ColorChoiceMenu

public ColorChoiceMenu(java.lang.String label,
                       java.lang.String defaultColor)

Constructs a menu of color choices. Puts the menu and a label introducing it into a panel. (Precondition: defaultColor is one of the labels from ColorChoiceDDMenu.STANDARD_CHOICES: "Red", "Orange", "Yellow", "Green", "Blue", "Indigo", "Violet", "White", "Gray", "Black", "Random", and "Other ...".)

Parameters:

label - label for color chooser

defaultColor - the color that should appear as the default on the menu when it is first constructed

ColorChoiceMenu

public ColorChoiceMenu(java.lang.String label,
                       ColorChoiceDDMenu.ColorChoice[] colorChoices,
                       ColorChoiceDDMenu.ColorChoice defaultColor)

Constructs a menu of color choices. Puts the menu and a label introducing it into a panel. (Precondition: defaultColor is one of the color choices in colorChoices.)

Parameters:

label - label for color chooser

colorChoices - the set of color choices to show in the drop-down menu

defaultColor - the color that should appear as the default on the menu when it is first constructed

Method Detail

addColorChoice

public void addColorChoice(NamedColor color)

Adds a new menu item to the menu with the given color, using its name as the name in the menu.

addColorChoice

public void addColorChoice(java.lang.String colorName,
                           java.awt.Color color)

Adds a new menu item to the menu with the given name and color.

act

public void act()

Performs any actions necessary when the color changes.

currentColor

public java.awt.Color currentColor()

Returns the current color from the drop-down menu.