org.proteinshader.gui.components.controlpanel
Class ColorPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.proteinshader.gui.components.controlpanel.ColorPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

AtomColorPanel, CartoonColorPanel

public abstract class ColorPanel
extends JPanel

This control panel allows the user to modify the color of Drawable objects.

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

ColorPanel(Mediator mediator, Frame dialogOwner, RadioPanel radioPanel, String default1Name, String default2Name)
Constructs a ColorPanel.

Method Summary

void	applyColors(float red, float green, float blue) Applies the RGB color to whatever item or items are currently selected in the RadioPanel.
void	applyDefaultColors1() Applies the default RGB color to whatever item or items are currently selected in the RadioPanel.
void	applyDefaultColors2() Applies the default RGB color to whatever item or items are currently selected in the RadioPanel.
void	modifyGlobal(AtomModifier atomModifier, BondModifier bondModifier, SegmentModifier segmentModifier) Passes the DrawableModifiers to the modifyGlobal() method of the RadioPanel.
abstract void	modifyGlobal(float red, float green, float blue) Prepares a DrawableModifier to modify the RGB color of Drawable objects, and then calls on the modifyGlobal() method of the RadioPanel.
abstract void	modifyGlobalToDefault1() Prepares the DrawableModifier to set RGB colors to a default value, and then calls on the modifyGlobal() method of the RadioPanel.
abstract void	modifyGlobalToDefault2()
void	modifyHelices(AtomModifier atomModifier, BondModifier bondModifier, SegmentModifier segmentModifier) Passes the DrawableModifiers to the modifyHelices() method of the RadioPanel.
abstract void	modifyHelices(float red, float green, float blue) Prepares a DrawableModifier to modify the RGB color of Drawable objects, and then calls on the modifyHelices() method of the RadioPanel.
abstract void	modifyHelicesToDefault1() Prepares the DrawableModifier to set RGB colors to a default value, and then calls on the modifyHelices() method of the RadioPanel.
abstract void	modifyHelicesToDefault2()
void	modifyLoops(AtomModifier atomModifier, BondModifier bondModifier, SegmentModifier segmentModifier) Passes the DrawableModifiers to the modifyLoops() method of the RadioPanel.
abstract void	modifyLoops(float red, float green, float blue) Prepares a DrawableModifier to modify the RGB color of Drawable objects, and then calls on the modifyLoops() method of the RadioPanel.
abstract void	modifyLoopsToDefault1() Prepares the DrawableModifier to set RGB colors to a default value, and then calls on the modifyLoops() method of the RadioPanel.
abstract void	modifyLoopsToDefault2()
void	modifySelected(AtomModifier atomModifier, BondModifier bondModifier, SegmentModifier segmentModifier) Passes the DrawableModifiers to the modifySelected() method of the RadioPanel.
abstract void	modifySelected(float red, float green, float blue) Prepares a DrawableModifier to modify the RGB color of Drawable objects, and then calls on the modifySelected() method of the RadioPanel.
abstract void	modifySelectedToDefault1() Prepares the DrawableModifier to set RGB colors to a default value, and then calls on the modifySelected() method of the RadioPanel.
abstract void	modifySelectedToDefault2()
void	modifyStrands(AtomModifier atomModifier, BondModifier bondModifier, SegmentModifier segmentModifier) Passes the DrawableModifiers to the modifyStrands() method of the RadioPanel.
abstract void	modifyStrands(float red, float green, float blue) Prepares a DrawableModifier to modify the RGB color of Drawable objects, and then calls on the modifyStrands() method of the RadioPanel.
abstract void	modifyStrandsToDefault1() Prepares the DrawableModifier to set RGB colors to a default value, and then calls on the modifyStrands() method of the RadioPanel.
abstract void	modifyStrandsToDefault2()
void	openColorChooser() Opens a JColorChooser in a dialog box.

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, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, 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, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, 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, 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, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, 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, 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, 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

Constructor Detail

ColorPanel

public ColorPanel(Mediator mediator,
                  Frame dialogOwner,
                  RadioPanel radioPanel,
                  String default1Name,
                  String default2Name)

Constructs a ColorPanel.

Parameters:

mediator - the centralized Mediator that most listeners need to call on to accomplish their task.

dialogOwner - the owner of any Dialogs opened from the SelectorPanel (or null if there is no owner).

radioPanel - the common RadioPanel used by subpanels.

default1Name - the name to put on the default 1 button.

default2Name - the name to put on the default 2 button.

Method Detail

applyColors

public void applyColors(float red,
                        float green,
                        float blue)

Applies the RGB color to whatever item or items are currently selected in the RadioPanel. If a color is out of range, the user will be informed through a JOptionPane.

Parameters:

red - the red component of the RGB color to set.

green - the green component of the RGB color to set.

blue - the blue component of the RGB color to set.

applyDefaultColors1

public void applyDefaultColors1()

Applies the default RGB color to whatever item or items are currently selected in the RadioPanel.

applyDefaultColors2

public void applyDefaultColors2()

Applies the default RGB color to whatever item or items are currently selected in the RadioPanel.

modifySelected

public abstract void modifySelected(float red,
                                    float green,
                                    float blue)
                             throws ColorOutOfRangeException

Prepares a DrawableModifier to modify the RGB color of Drawable objects, and then calls on the modifySelected() method of the RadioPanel.

Parameters:

red - the red component of the RGB color to set.

green - the green component of the RGB color to set.

blue - the blue component of the RGB color to set.

Throws:

ColorOutOfRangeException - if a color is less than 0.0 or greater than 1.0.

modifyHelices

public abstract void modifyHelices(float red,
                                   float green,
                                   float blue)
                            throws ColorOutOfRangeException

Prepares a DrawableModifier to modify the RGB color of Drawable objects, and then calls on the modifyHelices() method of the RadioPanel.

Parameters:

red - the red component of the RGB color to set.

green - the green component of the RGB color to set.

blue - the blue component of the RGB color to set.

Throws:

ColorOutOfRangeException - if a color is less than 0.0 or greater than 1.0.

modifyStrands

public abstract void modifyStrands(float red,
                                   float green,
                                   float blue)
                            throws ColorOutOfRangeException

Prepares a DrawableModifier to modify the RGB color of Drawable objects, and then calls on the modifyStrands() method of the RadioPanel.

Parameters:

red - the red component of the RGB color to set.

green - the green component of the RGB color to set.

blue - the blue component of the RGB color to set.

Throws:

ColorOutOfRangeException - if a color is less than 0.0 or greater than 1.0.

modifyLoops

public abstract void modifyLoops(float red,
                                 float green,
                                 float blue)
                          throws ColorOutOfRangeException

Prepares a DrawableModifier to modify the RGB color of Drawable objects, and then calls on the modifyLoops() method of the RadioPanel.

Parameters:

red - the red component of the RGB color to set.

green - the green component of the RGB color to set.

blue - the blue component of the RGB color to set.

Throws:

ColorOutOfRangeException - if a color is less than 0.0 or greater than 1.0.

modifyGlobal

public abstract void modifyGlobal(float red,
                                  float green,
                                  float blue)
                           throws ColorOutOfRangeException

Prepares a DrawableModifier to modify the RGB color of Drawable objects, and then calls on the modifyGlobal() method of the RadioPanel.

Parameters:

red - the red component of the RGB color to set.

green - the green component of the RGB color to set.

blue - the blue component of the RGB color to set.

Throws:

ColorOutOfRangeException - if a color is less than 0.0 or greater than 1.0.

modifySelectedToDefault1

public abstract void modifySelectedToDefault1()

Prepares the DrawableModifier to set RGB colors to a default value, and then calls on the modifySelected() method of the RadioPanel.

modifySelectedToDefault2

public abstract void modifySelectedToDefault2()

modifyHelicesToDefault1

public abstract void modifyHelicesToDefault1()

Prepares the DrawableModifier to set RGB colors to a default value, and then calls on the modifyHelices() method of the RadioPanel.

modifyHelicesToDefault2

public abstract void modifyHelicesToDefault2()

modifyStrandsToDefault1

public abstract void modifyStrandsToDefault1()

Prepares the DrawableModifier to set RGB colors to a default value, and then calls on the modifyStrands() method of the RadioPanel.

modifyStrandsToDefault2

public abstract void modifyStrandsToDefault2()

modifyLoopsToDefault1

public abstract void modifyLoopsToDefault1()

Prepares the DrawableModifier to set RGB colors to a default value, and then calls on the modifyLoops() method of the RadioPanel.

modifyLoopsToDefault2

public abstract void modifyLoopsToDefault2()

modifyGlobalToDefault1

public abstract void modifyGlobalToDefault1()

Prepares the DrawableModifier to set RGB colors to a default value, and then calls on the modifyGlobal() method of the RadioPanel.

modifyGlobalToDefault2

public abstract void modifyGlobalToDefault2()

modifySelected

public void modifySelected(AtomModifier atomModifier,
                           BondModifier bondModifier,
                           SegmentModifier segmentModifier)

Passes the DrawableModifiers to the modifySelected() method of the RadioPanel.

Parameters:

atomModifier - an AtomModifier programmed to modify Atoms (or null for no modifications).

bondModifier - a BondModifier programmed to modify Bonds (or null for no modifications).

segmentModifier - a SegmentModifier programmed to modify Segments (or null for no modifications).

modifyHelices

public void modifyHelices(AtomModifier atomModifier,
                          BondModifier bondModifier,
                          SegmentModifier segmentModifier)

Passes the DrawableModifiers to the modifyHelices() method of the RadioPanel.

Parameters:

atomModifier - an AtomModifier programmed to modify Atoms (or null for no modifications).

bondModifier - a BondModifier programmed to modify Bonds (or null for no modifications).

segmentModifier - a SegmentModifier programmed to modify Segments (or null for no modifications).

modifyStrands

public void modifyStrands(AtomModifier atomModifier,
                          BondModifier bondModifier,
                          SegmentModifier segmentModifier)

Passes the DrawableModifiers to the modifyStrands() method of the RadioPanel.

Parameters:

atomModifier - an AtomModifier programmed to modify Atoms (or null for no modifications).

bondModifier - a BondModifier programmed to modify Bonds (or null for no modifications).

segmentModifier - a SegmentModifier programmed to modify Segments (or null for no modifications).

modifyLoops

public void modifyLoops(AtomModifier atomModifier,
                        BondModifier bondModifier,
                        SegmentModifier segmentModifier)

Passes the DrawableModifiers to the modifyLoops() method of the RadioPanel.

Parameters:

atomModifier - an AtomModifier programmed to modify Atoms (or null for no modifications).

bondModifier - a BondModifier programmed to modify Bonds (or null for no modifications).

segmentModifier - a SegmentModifier programmed to modify Segments (or null for no modifications).

modifyGlobal

public void modifyGlobal(AtomModifier atomModifier,
                         BondModifier bondModifier,
                         SegmentModifier segmentModifier)

Passes the DrawableModifiers to the modifyGlobal() method of the RadioPanel.

Parameters:

atomModifier - an AtomModifier programmed to modify Atoms (or null for no modifications).

bondModifier - a BondModifier programmed to modify Bonds (or null for no modifications).

segmentModifier - a SegmentModifier programmed to modify Segments (or null for no modifications).

openColorChooser

public void openColorChooser()

Opens a JColorChooser in a dialog box.