TimeSlider

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - org.gvsig.timesupport.swing.impl.rdv.TimeSlider

All Implemented Interfaces:

MouseListener, MouseMotionListener, ImageObserver, MenuContainer, Serializable, EventListener
```
public class TimeSlider
extends JComponent
implements MouseListener, MouseMotionListener
```
A component that lets the user select a specific time or time range between a bounded time interval by sliding knobs along a timeline. It also allows one to display an event indicator at a specific time in the time line. (Modified by Pablo Viciano)

See Also:
Serialized Form

Nested Class Summary
- 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
`protected List<TimeRange>`	`actualTimeRanges` List of valid times ranges, taking into account the minimum and maximum
`protected double`	`end` The end of the selected time range.
`protected JButton`	`endButton` The button used to indicate the end time.
`protected boolean`	`left`
`protected double`	`maximum` The maximum time.
`static long`	`MILLIS_BY_DAY`
`static long`	`MILLIS_BY_HOUR`
`static long`	`MILLIS_BY_MINUTE`
`static long`	`MILLIS_BY_MONTH`
`static long`	`MILLIS_BY_SECOND`
`static long`	`MILLIS_BY_WEEK`
`static long`	`MILLIS_BY_YEAR`
`protected double`	`minimum` The minimum time.
`protected boolean`	`right`
`protected double`	`start` The start of the selected time range.
`protected JButton`	`startButton` The button used to indicate the start time.
`protected List<TimeRange>`	`timeRanges` List of event markers. * protected final List markers; /** List of valid time ranges.
`protected double`	`value` The selected time.
`protected JButton`	`valueButton` The button used to indicate the time.

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

Constructors
Constructor and Description

TimeSlider(boolean isAbsolute)
Creates a time slider with the maximum available range.

Constructors
Constructor and Description
`TimeSlider(boolean isAbsolute)` Creates a time slider with the maximum available range.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addTimeAdjustmentListener(TimeAdjustmentListener l)` Add a listener for time adjustments.
`void`	`clearTimeRanges()` Remove all time ranges.
`JToolTip`	`createToolTip()` Creates the tooltip for the component.
`void`	`doLayout()` Layout the buttons.
`protected void`	`fireBoundsChanged()` Fires a bounds changed event to all adjustment listeners.
`void`	`fireRangeChanged()` Fires a range changed event to all adjustment listeners.
`void`	`fireValueChanged()` Fires a value changed event to all adjustment listeners.
`double`	`getActualMaximum()` Get the maximum value allowed on the time slider.
`double`	`getActualMinimum()` Get the minimum value allowed on the time slider.
`Instant`	`getCurrentInstant()` Get the current DateTime if the value is changeable or null if the value isn't changeable.
`Instant`	`getEndInstant()` Returns a DateTime instance to represents the end date
`double`	`getMaximum()` Gets the maximum allowed time value.
`double`	`getMinimum()` Gets the minimum allowed time value.
`Dimension`	`getMinimumSize()` Get the minimum dimensions for this component.
`double`	`getNextValidTime(double time)` Get a time that is valid and greater than or equal to the current one.
`Dimension`	`getPreferredSize()` Get the preferred size for this component.
`Instant`	`getStartInstant()` Gets the text for the tooltip.
`boolean`	`getValueChangeable()`
`boolean`	`isTimeValid(double time)` Tell if the time is valid with respect to the current time bounds and ranges.
`boolean`	`isValueAdjusting()` Indicates if the value is being continuously changed in the UI.
`void`	`mouseClicked(MouseEvent me)` Called when the mouse is clicked.
`void`	`mouseDragged(MouseEvent me)` Called when the mouse is dragged.
`void`	`mouseEntered(MouseEvent me)`
`void`	`mouseExited(MouseEvent me)`
`void`	`mouseMoved(MouseEvent me)`
`void`	`mousePressed(MouseEvent me)` Called when the mouse is pressed.
`void`	`mouseReleased(MouseEvent me)` Called whn the mouse is released.
`void`	`moveLeft(boolean left)`
`void`	`moveRight(boolean right)`
`protected void`	`paintComponent(Graphics g)` Paint the components.
`void`	`removeTimeAdjustmentListener(TimeAdjustmentListener l)` Remove a listener for time adjustments.
`void`	`resetAllDates()` Reset all dates
`void`	`resetMaximumBound()` Reset to maximum date
`void`	`resetMinimumBound()` Reset to minimum date
`void`	`resetValue()` Reset to initial value date
`void`	`setCurrentInstant(Instant currentInstant)` Sets the current time of the slider
`void`	`setEnabled(boolean enabled)` Sets if this component is enabled.
`void`	`setEndInstant(Instant endInstant)` Sets the end DateTime of the slider
`void`	`setRangeChangeable(boolean changeable)` Set if a time range can be changed via the UI elements
`void`	`setStartInstant(Instant startInstant)` Set the start DateTime of the slider
`void`	`setTimeRanges(List<TimeRange> newTimeRanges)` Replace the current set of time ranges with this one.
`void`	`setValueChangeable(boolean changeable)` Sets if the time value of the slider can be changed by the UI element.
`void`	`setValues(Instant minimunInstant, Instant maximumInstant)`
`void`	`setValueVisible(boolean visible)` Set if the value is visible in the slider UI.

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, getNextFocusableComponent, getPopupLocation, 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, 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, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, 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, 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, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - MILLIS_BY_SECOND
```
public static final long MILLIS_BY_SECOND
```
    See Also:
    Constant Field Values
  - MILLIS_BY_MINUTE
```
public static final long MILLIS_BY_MINUTE
```
    See Also:
    Constant Field Values
  - MILLIS_BY_HOUR
```
public static final long MILLIS_BY_HOUR
```
    See Also:
    Constant Field Values
  - MILLIS_BY_DAY
```
public static final long MILLIS_BY_DAY
```
    See Also:
    Constant Field Values
  - MILLIS_BY_WEEK
```
public static final long MILLIS_BY_WEEK
```
    See Also:
    Constant Field Values
  - MILLIS_BY_MONTH
```
public static final long MILLIS_BY_MONTH
```
    See Also:
    Constant Field Values
  - MILLIS_BY_YEAR
```
public static final long MILLIS_BY_YEAR
```
    See Also:
    Constant Field Values
  - minimum
```
protected double minimum
```
    The minimum time.
  - start
```
protected double start
```
    The start of the selected time range.
  - value
```
protected double value
```
    The selected time.
  - end
```
protected double end
```
    The end of the selected time range.
  - maximum
```
protected double maximum
```
    The maximum time.
  - timeRanges
```
protected final List<TimeRange> timeRanges
```
    List of event markers. * protected final List markers; /** List of valid time ranges.
  - actualTimeRanges
```
protected final List<TimeRange> actualTimeRanges
```
    List of valid times ranges, taking into account the minimum and maximum
  - startButton
```
protected final JButton startButton
```
    The button used to indicate the start time.
  - valueButton
```
protected final JButton valueButton
```
    The button used to indicate the time.
  - endButton
```
protected final JButton endButton
```
    The button used to indicate the end time.
  - right
```
protected boolean right
```
  - left
```
protected boolean left
```
- Constructor Detail
  - TimeSlider
```
public TimeSlider(boolean isAbsolute)
```
    Creates a time slider with the maximum available range.
- Method Detail
  - setValueChangeable
```
public void setValueChangeable(boolean changeable)
```
    Sets if the time value of the slider can be changed by the UI element.
    
    Parameters:
    changeable - if true, the value can be changed, false otherwise.
  - getValueChangeable
```
public boolean getValueChangeable()
```
  - setValueVisible
```
public void setValueVisible(boolean visible)
```
    Set if the value is visible in the slider UI.
    
    Parameters:
    visible - if true the value is shown, if false the value is not shown
  - setRangeChangeable
```
public void setRangeChangeable(boolean changeable)
```
    Set if a time range can be changed via the UI elements
    
    Parameters:
    changeable - if true, the time range can be changed, false otherwsie
  - moveRight
```
public void moveRight(boolean right)
```
  - moveLeft
```
public void moveLeft(boolean left)
```
  - setCurrentInstant
```
public void setCurrentInstant(Instant currentInstant)
```
    Sets the current time of the slider
    
    Parameters:
    current -
  - setStartInstant
```
public void setStartInstant(Instant startInstant)
```
    Set the start DateTime of the slider
    
    Parameters:
    start -
  - setEndInstant
```
public void setEndInstant(Instant endInstant)
```
    Sets the end DateTime of the slider
    
    Parameters:
    end -
  - setValues
```
public void setValues(Instant minimunInstant,
             Instant maximumInstant)
```
  - getMinimum
```
public double getMinimum()
```
    Gets the minimum allowed time value.
    
    Returns:
    the minimum allowed time value
  - getMaximum
```
public double getMaximum()
```
    Gets the maximum allowed time value.
    
    Returns:
    the maximum allowed time value.
  - resetMinimumBound
```
public void resetMinimumBound()
```
    Reset to minimum date
  - resetMaximumBound
```
public void resetMaximumBound()
```
    Reset to maximum date
  - resetValue
```
public void resetValue()
```
    Reset to initial value date
  - resetAllDates
```
public void resetAllDates()
```
    Reset all dates
  - setTimeRanges
```
public void setTimeRanges(List<TimeRange> newTimeRanges)
```
    Replace the current set of time ranges with this one.
    
    Parameters:
    newTimeRanges - a list of time ranges
  - isTimeValid
```
public boolean isTimeValid(double time)
```
    Tell if the time is valid with respect to the current time bounds and ranges.
    
    Parameters:
    time - the time to check
    
    Returns:
    true if the time is valid, false if it is not
  - getNextValidTime
```
public double getNextValidTime(double time)
```
    Get a time that is valid and greater than or equal to the current one.
    
    Returns:
    the next valid time, or -1 if there is none
  - clearTimeRanges
```
public void clearTimeRanges()
```
    Remove all time ranges.
  - isValueAdjusting
```
public boolean isValueAdjusting()
```
    Indicates if the value is being continuously changed in the UI.
    
    Returns:
    true if the value is changing, false otherwise
  - getActualMinimum
```
public double getActualMinimum()
```
    Get the minimum value allowed on the time slider. This takes into account the time ranges.
    
    Returns:
    the minimum value allowed on the time slider
  - getActualMaximum
```
public double getActualMaximum()
```
    Get the maximum value allowed on the time slider. This takes into account the time ranges.
    
    Returns:
    the maximum value allowed on the time slider
  - doLayout
```
public void doLayout()
```
    Layout the buttons.
    
    Overrides:
    
    doLayout in class Container
  - paintComponent
```
protected void paintComponent(Graphics g)
```
    Paint the components. Also paint the slider and the markers.
    
    Overrides:
    
    paintComponent in class JComponent
  - getMinimumSize
```
public Dimension getMinimumSize()
```
    Get the minimum dimensions for this component.
    
    Overrides:
    
    getMinimumSize in class JComponent
    
    Returns:
    the minimum dimensions
  - getPreferredSize
```
public Dimension getPreferredSize()
```
    Get the preferred size for this component.
    
    Overrides:
    
    getPreferredSize in class JComponent
    
    Returns:
    the preferred dimensions
  - createToolTip
```
public JToolTip createToolTip()
```
    Creates the tooltip for the component. This changes the default tooltip by setting a different border.
    
    Overrides:
    
    createToolTip in class JComponent
    
    Returns:
    the tooltip created
  - getStartInstant
```
public Instant getStartInstant()
```
    Gets the text for the tooltip. This will return a description of the markers the mouse pointer is around.
    
    Parameters:
    me - the mouse event that triggered this
    
    Returns:
    text describing the markers around the mouse pointer public String getToolTipText(MouseEvent me) { int x = me.getX(); if (me.getSource() == valueButton) { x += valueButton.getX(); } double time = getTimeFromX(x); double timeOffset = time - value; double markerOffset = 2 * getPixelTime(); // List markersOver = getMarkersAroundTime(time, // markerOffset); String text = new String(""); return text; } /** Returns a DateTime instance to represents the start date
  - getEndInstant
```
public Instant getEndInstant()
```
    Returns a DateTime instance to represents the end date
  - getCurrentInstant
```
public Instant getCurrentInstant()
```
    Get the current DateTime if the value is changeable or null if the value isn't changeable.
    
    Returns:
  - mouseDragged
```
public void mouseDragged(MouseEvent me)
```
    Called when the mouse is dragged. This deals dragging the time value and range controls.
    
    Specified by:
    
    mouseDragged in interface MouseMotionListener
    
    Parameters:
    me - the mosue event that triggered this
  - mousePressed
```
public void mousePressed(MouseEvent me)
```
    Called when the mouse is pressed. Used to tell when the value control is being adjusted.
    
    Specified by:
    
    mousePressed in interface MouseListener
    
    Parameters:
    me - the mouse event that triggered this
  - mouseReleased
```
public void mouseReleased(MouseEvent me)
```
    Called whn the mouse is released. Used to tell when the value control is being adjusted.
    
    Specified by:
    
    mouseReleased in interface MouseListener
    
    Parameters:
    me - the mouse event that triggered this
  - mouseMoved
```
public void mouseMoved(MouseEvent me)
```
    Specified by:
    
    mouseMoved in interface MouseMotionListener
  - mouseClicked
```
public void mouseClicked(MouseEvent me)
```
    Called when the mouse is clicked. Used to set the time value when there is a click on the time slider.
    
    Specified by:
    
    mouseClicked in interface MouseListener
    
    Parameters:
    me - the mouse event that triggered this
  - mouseEntered
```
public void mouseEntered(MouseEvent me)
```
    Specified by:
    
    mouseEntered in interface MouseListener
  - mouseExited
```
public void mouseExited(MouseEvent me)
```
    Specified by:
    
    mouseExited in interface MouseListener
  - addTimeAdjustmentListener
```
public void addTimeAdjustmentListener(TimeAdjustmentListener l)
```
    Add a listener for time adjustments.
    
    Parameters:
    l - the listener to add
  - removeTimeAdjustmentListener
```
public void removeTimeAdjustmentListener(TimeAdjustmentListener l)
```
    Remove a listener for time adjustments.
    
    Parameters:
    l - the listener to remove
  - fireValueChanged
```
public void fireValueChanged()
```
    Fires a value changed event to all adjustment listeners.
  - fireRangeChanged
```
public void fireRangeChanged()
```
    Fires a range changed event to all adjustment listeners.
  - fireBoundsChanged
```
protected void fireBoundsChanged()
```
    Fires a bounds changed event to all adjustment listeners.
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Sets if this component is enabled. If the component is not enabled, the time value and range controls will not respond to user input.
    
    Overrides:
    
    setEnabled in class JComponent
    
    Parameters:
    enabled - true if this component should be enabled, false otherwise

Class TimeSlider

Nested Class Summary

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

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

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

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

MILLIS_BY_SECOND

MILLIS_BY_MINUTE

MILLIS_BY_HOUR

MILLIS_BY_DAY

MILLIS_BY_WEEK

MILLIS_BY_MONTH

MILLIS_BY_YEAR

minimum

start

value

end

maximum

timeRanges

actualTimeRanges

startButton

valueButton

endButton

right

left

Constructor Detail

TimeSlider

Method Detail

setValueChangeable

getValueChangeable

setValueVisible

setRangeChangeable

moveRight

moveLeft

setCurrentInstant

setStartInstant

setEndInstant

setValues

getMinimum

getMaximum

resetMinimumBound

resetMaximumBound

resetValue

resetAllDates

setTimeRanges

isTimeValid

getNextValidTime

clearTimeRanges

isValueAdjusting

getActualMinimum

getActualMaximum

doLayout

paintComponent

getMinimumSize

getPreferredSize

createToolTip

getStartInstant

getEndInstant

getCurrentInstant

mouseDragged

mousePressed

mouseReleased

mouseMoved

mouseClicked

mouseEntered

mouseExited

addTimeAdjustmentListener

removeTimeAdjustmentListener

fireValueChanged

fireRangeChanged