org.gephi.ui.components.gradientslider

Class GradientSlider

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.gephi.ui.components.gradientslider.MultiThumbSlider

org.gephi.ui.components.gradientslider.GradientSlider

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

public class GradientSlider
extends MultiThumbSlider

This component lets the user manipulate the colors in a gradient. A GradientSlider can contain any number of thumbs. The slider itself represents a range of values from zero to one, so the thumbs must always be within this range. Each thumb maps to a specific Color.

There are some specific properties you can set to customize the look-and-feel of this slider in the default GradientSliderUI class.

The UI for each slider is loaded from the UIManager property: "GradientSliderUI". By default this is "org.gephi.ui.components.gradientslider.GradientSliderUI".

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	GradientSlider.AbstractPopup
(package private) class	GradientSlider.ColorPickerPopup
(package private) class	GradientSlider.SelectThumbRunnable

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.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
(package private) JPopupMenu	popup The popup for contextual menus.
private static long	serialVersionUID

Fields inherited from class org.gephi.ui.components.gradientslider.MultiThumbSlider

ADJUST_PROPERTY, adjusting, autoAdd, blocked, changeListeners, HORIZONTAL, inverted, INVERTED_PROPERTY, orientation, ORIENTATION_PROPERTY, PAINT_TICKS_PROPERTY, paintTicks, SELECTED_THUMB_PROPERTY, thumbPositions, values, VALUES_PROPERTY, VERTICAL

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Constructor and Description
GradientSlider() Create a horizontal GradientSlider that represents a gradient from white to black.
GradientSlider(int orientation) Create a GradientSlider that represents a gradient form white to black.
GradientSlider(int orientation, float[] thumbPositions, Color[] values) Create a new GradientSlider.

Method Summary

Modifier and Type	Method and Description
private JPopupMenu	createPopup()
boolean	doDoubleClick(int x, int y) This invokes a ColorPicker dialog to edit the thumb at the selected index.
boolean	doPopup(int x, int y) This shows a mini ColorPicker panel to let the user change the selected color.
Color[]	getColors() This is identical to getValues(), except the return value is an array of Colors.
private Frame	getFrame()
Object	getValue(float pos) Returns the Color at the specified position.
private boolean	showColorPicker()
private void	showJColorChooser() TODO: If developers don't want to bundle the ColorPicker with their programs, they can use this method instead of showColorPicker().
private static Color	tween(Color c1, Color c2, float p)
void	updateUI()

Methods inherited from class org.gephi.ui.components.gradientslider.MultiThumbSlider

addChangeListener, addThumb, fireChangeListeners, getOrientation, getSelectedThumb, getSelectedThumb, getThumbCount, getThumbPositions, getValues, isAutoAdding, isBlocked, isInverted, isPaintTicks, isValueAdjusting, removeChangeListener, removeThumb, setAutoAdding, setBlocked, setInverted, setOrientation, setPaintTicks, setSelectedThumb, setValueIsAdjusting, setValues, transferFocus, transferFocusBackward

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, getBaseline, getBaselineResizeBehavior, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, 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, getAccessibleContext, 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, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

popup

JPopupMenu popup

The popup for contextual menus.

Constructor Detail

GradientSlider

public GradientSlider()

Create a horizontal GradientSlider that represents a gradient from white to black.

GradientSlider

public GradientSlider(int orientation)

Create a GradientSlider that represents a gradient form white to black.

Parameters:

orientation - HORIZONTAL or VERTICAL

GradientSlider

public GradientSlider(int orientation,
                      float[] thumbPositions,
                      Color[] values)

Create a new GradientSlider.

Parameters:

orientation - HORIZONTAL or VERTICAL

thumbPositions - the initial positions of each thumb

values - the initial colors at each position

Throws:

IllegalArgumentException - if the number of elements in thumbPositions does not equal the number of elements in values.

Method Detail

getValue

public Object getValue(float pos)

Returns the Color at the specified position.

Specified by:

getValue in class MultiThumbSlider

Parameters:

pos - a position between zero and one

Returns:

color

getColors

public Color[] getColors()

This is identical to getValues(), except the return value is an array of Colors.

Returns:

color array

tween

private static Color tween(Color c1,
                           Color c2,
                           float p)

doDoubleClick

public boolean doDoubleClick(int x,
                             int y)

This invokes a ColorPicker dialog to edit the thumb at the selected index.

Overrides:

doDoubleClick in class MultiThumbSlider

Parameters:

x - the x-value of the mouse click location

y - the y-value of the mouse click location

Returns:

return true if successful

createPopup

private JPopupMenu createPopup()

doPopup

public boolean doPopup(int x,
                       int y)

This shows a mini ColorPicker panel to let the user change the selected color.

Overrides:

doPopup in class MultiThumbSlider

Parameters:

x - the x-value of the mouse click location

y - the y-value of the mouse click location

Returns:

true if successful

getFrame

private Frame getFrame()

showColorPicker

private boolean showColorPicker()

showJColorChooser

private void showJColorChooser()

TODO: If developers don't want to bundle the ColorPicker with their programs, they can use this method instead of showColorPicker().

updateUI

public void updateUI()

Overrides:

updateUI in class JComponent