Package pamScrollSystem

Class PamScroller

java.lang.Object

pamScrollSystem.AbstractPamScroller

pamScrollSystem.AbstractPamScrollerAWT

pamScrollSystem.PamScroller

All Implemented Interfaces:

Serializable, DataTimeLimits

Direct Known Subclasses:

TDPamScroller

public class PamScroller
extends AbstractPamScrollerAWT

See Also:

• Serialized Form

Field Summary

Fields inherited from class pamScrollSystem.AbstractPamScrollerAWT

HORIZONTAL, VERTICAL

Fields inherited from class pamScrollSystem.AbstractPamScroller

needsNotify, observers, pamMenuParts, playSpeeds, scrollerData, scrollManager, usedDataBlocks

Constructor Summary

Constructors

Constructor	Description
PamScroller(String name, int orientation, int stepSizeMillis, long defaultLoadTime, boolean hasMenu)	Construct a Pamguard scroll bar which contains a main scroll bar bit and buttons for moving forward in large secScollbar name (used in scroll bar management)

Method Summary

Modifier and Type	Method	Description
void	addControl(JComponent component)	Add an additional control to the control panel which will sit to the right of or just below the wee buttons used for scroll bar navigation.
void	anotherScrollerMovedInner(long newValue)	Another managed scroller moved it's position
long	getBlockIncrement()
JComponent	getComponent()
JScrollBar	getScrollBar()
long	getValueMillis()	The start time of the scroller in milliseconds.
long	getVisibleAmount()	This will be none for sliders, such as on the map.
void	rangesChanged(long setValue)	Called when ranges have been changed and tells scroller to go to a particular absolute value.
void	scrollMoved()
void	setBlockIncrement(long blockIncrement)
void	setShowTimes(boolean showTimes)
void	setUnitIncrement(long unitIncrement)
void	setVisibleMillis(long visibleAmount)
String	toString()
void	valueSetMillis(long valueMillis)	Called when a new position has been set

Methods inherited from class pamScrollSystem.AbstractPamScrollerAWT

addMouseWheelSource, createScrollComponenent, createScrollComponenent, getButtonPanel, getStandardOptionsMenu, isShowing, menuButtonPress, playbackStarted, playbackStopped, setVisible, showPlaybackMenu

Methods inherited from class pamScrollSystem.AbstractPamScroller

addDataBlock, addMenuParts, addObserver, anotherScrollerMovedOuter, coupledScrollerChanged, coupleScroller, destroyScroller, getDefaultLoadtime, getMaximumMillis, getMinimumMillis, getNumUsedDataBlocks, getObservers, getPageStep, getPamMenuParts, getRangeMillis, getScrollerCoupling, getScrollerData, getScrollManager, getSpecialLoadTimes, getStepSizeMillis, getUsedDataBlock, getVisibleEnd, isDataBlockUsed, isInSpecialList, notifyRangeChange, notifyValueChange, pageBack, pageForward, playTimerAction, rangesChangedF, reLoad, removeAllDataBlocks, removeDataBlock, removeObserver, setDefaultLoadtime, setPageStep, setRangeMillis, setScrollerCoupling, setStepSizeMillis, setValueMillis, startPlayback, stopPlayback, uncoupleScroller

Methods inherited from class java.lang.Object

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

Constructor Details

PamScroller

public PamScroller(String name,
 int orientation,
 int stepSizeMillis,
 long defaultLoadTime,
 boolean hasMenu)

Construct a Pamguard scroll bar which contains a main scroll bar bit and buttons for moving forward in large secScollbar name (used in scroll bar management)

Parameters:

name - Scroller name

orientation - AbstractPamScroller.VERTICAL or AbstractPamScroller.HORIZONTAL

stepSizeMillis - step size in milliseconds for scroller.

defaultLoadTime - default amount of data to load.

hasMenu - true if menu options should be shown in navigation area.

Method Details

setShowTimes

public void setShowTimes(boolean showTimes)

addControl

public void addControl(JComponent component)

Add an additional control to the control panel which will sit to the right of or just below the wee buttons used for scroll bar navigation.

Parameters:

component -

rangesChanged

public void rangesChanged(long setValue)

Description copied from class: AbstractPamScroller

Called when ranges have been changed and tells scroller to go to a particular absolute value.

Specified by:

rangesChanged in class AbstractPamScroller

Parameters:

setValue -

scrollMoved

public void scrollMoved()

anotherScrollerMovedInner

public void anotherScrollerMovedInner(long newValue)

Description copied from class: AbstractPamScroller

Another managed scroller moved it's position

Specified by:

anotherScrollerMovedInner in class AbstractPamScroller

Parameters:

newValue - new value in millis

getComponent

public JComponent getComponent()

Specified by:

getComponent in class AbstractPamScrollerAWT

Returns:

the Swing component to go into the GUI.

setBlockIncrement

public void setBlockIncrement(long blockIncrement)

Overrides:

setBlockIncrement in class AbstractPamScroller

Parameters:

blockIncrement - the blockIncrement to set in millis

getBlockIncrement

public long getBlockIncrement()

setVisibleMillis

public void setVisibleMillis(long visibleAmount)

Overrides:

setVisibleMillis in class AbstractPamScroller

Parameters:

visibleAmount - the visibleAmount to set in millis

getVisibleAmount

public long getVisibleAmount()

Description copied from class: AbstractPamScroller

This will be none for sliders, such as on the map. For other scrollers it should be the same as the time displayed in to the navigaiton buttons of the scroller.

Specified by:

getVisibleAmount in class AbstractPamScroller

Returns:

The visible amount of the display in milliseconds.

setUnitIncrement

public void setUnitIncrement(long unitIncrement)

Overrides:

setUnitIncrement in class AbstractPamScroller

Parameters:

unitIncrement - the unitIncrement to set in millis

getValueMillis

public long getValueMillis()

Description copied from class: AbstractPamScroller

The start time of the scroller in milliseconds. This is the current position of the scroller NOT the start time of loaded data.

Specified by:

getValueMillis in class AbstractPamScroller

Returns:

the valueMillis

valueSetMillis

public void valueSetMillis(long valueMillis)

Description copied from class: AbstractPamScroller

Called when a new position has been set

Specified by:

valueSetMillis in class AbstractPamScroller

Parameters:

valueMillis - new scroll value in milliseconds

toString

public String toString()

Overrides:

toString in class AbstractPamScroller

getScrollBar

public JScrollBar getScrollBar()