com.jidesoft.swing
Class RangeSlider

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JSlider
                  com.jidesoft.swing.RangeSlider

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants

public class RangeSlider
extends JSlider

RangeSlider is a slider that can be used to select a range. A regular slider has only one thumb. So it can only be used to select one value. RangeSlider has two thumbs. Each one can be moved independently or both are moved together.

getLowValue() will return the value of low range and getHighValue() is the high range.

See Also:

Serialized Form

Nested Class Summary

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

JSlider.AccessibleJSlider

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

static String	CLIENT_PROPERTY_ADJUST_ACTION
static String	CLIENT_PROPERTY_MOUSE_POSITION
static String	PROPERTY_HIGH_VALUE
static String	PROPERTY_LOW_VALUE

Fields inherited from class javax.swing.JSlider

changeEvent, changeListener, majorTickSpacing, minorTickSpacing, orientation, sliderModel, snapToTicks

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 javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

RangeSlider()
Creates a horizontal range slider with the range 0 to 100 and initial low and high values both at 50.

RangeSlider(int orientation)
Creates a range slider using the specified orientation with the range 0 to 100 and initial low and high values both at 50.

RangeSlider(int min, int max)
Creates a horizontal slider using the specified min and max with an initial value equal to the average of the min plus max.

RangeSlider(int min, int max, int low, int high)
Creates a horizontal slider using the specified min, max, low and high value.

Method Summary

boolean	contains(int value) Returns true if the specified value is within the range slider's range.
String	getActualUIClassID()
int	getHighValue() Returns the range slider's high value.
int	getLowValue() Returns the range slider's low value.
boolean	isRangeDraggable() Checks if the range is draggable.
void	setHighValue(int highValue) Sets the range slider's high value.
void	setLowValue(int lowValue) Sets the range slider's low value.
void	setRangeDraggable(boolean rangeDraggable) Sets the flag if the range is draggable.
void	setValue(int value)
void	updateUI()

Methods inherited from class javax.swing.JSlider

addChangeListener, createChangeListener, createStandardLabels, createStandardLabels, fireStateChanged, getAccessibleContext, getChangeListeners, getExtent, getInverted, getLabelTable, getMajorTickSpacing, getMaximum, getMinimum, getMinorTickSpacing, getModel, getOrientation, getPaintLabels, getPaintTicks, getPaintTrack, getSnapToTicks, getUI, getUIClassID, getValue, getValueIsAdjusting, paramString, removeChangeListener, setExtent, setFont, setInverted, setLabelTable, setMajorTickSpacing, setMaximum, setMinimum, setMinorTickSpacing, setModel, setOrientation, setPaintLabels, setPaintTicks, setPaintTrack, setSnapToTicks, setUI, setValueIsAdjusting, updateLabelUIs

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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, 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

Field Detail

CLIENT_PROPERTY_MOUSE_POSITION

public static final String CLIENT_PROPERTY_MOUSE_POSITION

See Also:

Constant Field Values

CLIENT_PROPERTY_ADJUST_ACTION

public static final String CLIENT_PROPERTY_ADJUST_ACTION

See Also:

Constant Field Values

PROPERTY_LOW_VALUE

public static final String PROPERTY_LOW_VALUE

See Also:

Constant Field Values

PROPERTY_HIGH_VALUE

public static final String PROPERTY_HIGH_VALUE

See Also:

Constant Field Values

Constructor Detail

RangeSlider

public RangeSlider()

Creates a horizontal range slider with the range 0 to 100 and initial low and high values both at 50.

RangeSlider

public RangeSlider(int orientation)

Creates a range slider using the specified orientation with the range 0 to 100 and initial low and high values both at 50.

Parameters:

orientation - the orientation of the RangeSlider.

RangeSlider

public RangeSlider(int min,
                   int max)

Creates a horizontal slider using the specified min and max with an initial value equal to the average of the min plus max. and initial low and high values both at 50.

Parameters:

min - the minimum value of the slider.

max - the maximum value of the slider.

RangeSlider

public RangeSlider(int min,
                   int max,
                   int low,
                   int high)

Creates a horizontal slider using the specified min, max, low and high value.

Parameters:

min - the minimum value of the slider.

max - the maximum value of the slider.

low - the low value of the slider since it is a range.

high - the high value of the slider since it is a range.

Method Detail

getActualUIClassID

public String getActualUIClassID()

updateUI

public void updateUI()

Overrides:

updateUI in class JSlider

getLowValue

public int getLowValue()

Returns the range slider's low value.

Returns:

the range slider's low value.

getHighValue

public int getHighValue()

Returns the range slider's high value.

Returns:

the range slider's high value.

contains

public boolean contains(int value)

Returns true if the specified value is within the range slider's range.

Parameters:

value - value

Returns:

true if the specified value is within the range slider's range.

setValue

public void setValue(int value)

Overrides:

setValue in class JSlider

setLowValue

public void setLowValue(int lowValue)

Sets the range slider's low value. This method just forwards the value to the model.

Parameters:

lowValue - the new low value

setHighValue

public void setHighValue(int highValue)

Sets the range slider's high value. This method just forwards the value to the model.

Parameters:

highValue - the new high value

isRangeDraggable

public boolean isRangeDraggable()

Checks if the range is draggable. If true, user can drag the area between the two thumbs to drag the range.

Returns:

true or false.

setRangeDraggable

public void setRangeDraggable(boolean rangeDraggable)

Sets the flag if the range is draggable. If true, user can drag the area between the two thumbs to drag the range.

Parameters:

rangeDraggable - true or false.