jwo.utils.gui
Class JWColourSelect

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      jwo.utils.gui.JWDialogue
                          jwo.utils.gui.JWColourSelect

All Implemented Interfaces:

ActionListener, FocusListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, ChangeListener, RootPaneContainer, WindowConstants

public class JWColourSelect
extends JWDialogue
implements ActionListener, FocusListener, ChangeListener

Creates a graphic colour selector. Colours can be chosen by (i) giving decimal RGB values; (ii) decimal HSV values; (iii) graphic selection of HSV.

Version:

2.3, 4th October, 2007

Author:

Jo Wood

See Also:

Serialized Form

Nested Class Summary

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

JDialog.AccessibleJDialog

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

Dialog.AccessibleAWTDialog

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

Window.AccessibleAWTWindow

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 jwo.utils.gui.JWDialogue

DIALOGUE, MONOLOGUE

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

JWColourSelect(Frame parentFrame)
Creates the dialogue layout for the colour selector with default (red) initial colour.

JWColourSelect(Frame parentFrame, Color initCol)
Creates the dialogue layout for the colour selector with the given initial colour.

JWColourSelect(Frame parentFrame, Color initCol, JWColourListener colourListener)
Creates the dialogue layout for the colour selector with the given initial colour and colour listener.

Method Summary

void	actionPerformed(ActionEvent event) Dynamically updates all colour text when return pressed in any text fields so that RGB and HSB values are consistent.
void	addColourListener(JWColourListener colourListener) Adds a colour listener to be informed of user changes in colour.
void	focusGained(FocusEvent event) Invoked when a text field gains the keyboard focus.
void	focusLost(FocusEvent event) Invoked when a text field loses the keyboard focus.
Color	getColour() Reports the currently selected colour.
boolean	removeColourListener(JWColourListener colourListener) Removes a colour listener from those to be informed of changes in colour.
void	setColour(Color newColour) Sets the currently selected colour to a given value.
void	stateChanged(ChangeEvent e) Responds to a change in a slider by updating the alpha value.

Methods inherited from class jwo.utils.gui.JWDialogue

addDialogueListener, checkInput, closedown, getContentPane, isChanged, removeDialogueListener, setFullBackground

Methods inherited from class javax.swing.JDialog

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

Methods inherited from class java.awt.Dialog

addNotify, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, toBack, 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, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, 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, isOpaque, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

JWColourSelect

public JWColourSelect(Frame parentFrame)

Creates the dialogue layout for the colour selector with default (red) initial colour.

Parameters:

parentFrame - Frame that calls this selector.

JWColourSelect

public JWColourSelect(Frame parentFrame,
                      Color initCol)

Creates the dialogue layout for the colour selector with the given initial colour.

Parameters:

parentFrame - Frame that calls this selector.

initCol - Initial colour to be displayed in chooser.

JWColourSelect

public JWColourSelect(Frame parentFrame,
                      Color initCol,
                      JWColourListener colourListener)

Creates the dialogue layout for the colour selector with the given initial colour and colour listener.

Parameters:

parentFrame - Frame that calls this selector.

initCol - Initial colour to be displayed in chooser.

colourListener - Listener to be informed if colour is changed.

Method Detail

addColourListener

public void addColourListener(JWColourListener colourListener)

Adds a colour listener to be informed of user changes in colour.

Parameters:

colourListener - Colour listener to be informed of colour changes.

removeColourListener

public boolean removeColourListener(JWColourListener colourListener)

Removes a colour listener from those to be informed of changes in colour.

Parameters:

colourListener - Colour listener to be removed.

Returns:

True if listener was found and then removed successfully.

getColour

public Color getColour()

Reports the currently selected colour.

Returns:

Currently selected colour.

setColour

public void setColour(Color newColour)

Sets the currently selected colour to a given value.

Parameters:

newColour - New colour to store.

actionPerformed

public void actionPerformed(ActionEvent event)

Dynamically updates all colour text when return pressed in any text fields so that RGB and HSB values are consistent.

Specified by:

actionPerformed in interface ActionListener

Parameters:

event - Event representing a change in a text field.

focusLost

public void focusLost(FocusEvent event)

Invoked when a text field loses the keyboard focus. Ensures that the current colour is consistent with the contents of the text field.

Specified by:

focusLost in interface FocusListener

Parameters:

event - Focus event.

focusGained

public void focusGained(FocusEvent event)

Invoked when a text field gains the keyboard focus. Does nothing in this case.

Specified by:

focusGained in interface FocusListener

Parameters:

event - Focus event.

stateChanged

public void stateChanged(ChangeEvent e)

Responds to a change in a slider by updating the alpha value.

Specified by:

stateChanged in interface ChangeListener

Parameters:

e - Slider change event.