pamScrollSystem

Class AbstractPamScroller

java.lang.Object

pamScrollSystem.AbstractPamScroller

Direct Known Subclasses:

AbstractPamScrollerAWT

public abstract class AbstractPamScroller
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AbstractPamScroller(java.lang.String name, int orientation, int stepSizeMillis, long defaultLoadTime, boolean hasMenu)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDataBlock(PamDataBlock dataBlock) Add a datablock to the list for this scroller.
void	addObserver(PamScrollObserver pamScrollObserver) Ad an observer that will receive notifications when the the scroller moves.
abstract void	anotherScrollerMovedInner(long newValue) Another managed scroller moved it's position
void	anotherScrollerMovedOuter(long newMin, long newMax) Another managed scroller moved its outer position - will cause new data to be loaded.
void	coupledScrollerChanged(AbstractPamScroller scroller) Called when a scroller which is coupled to this scroller changes in any way.
ScrollerCoupling	coupleScroller(java.lang.String couplingName) Couple this scroller to another scroller so that both have exactly the same behaviour, load the same data period, move their scrolls together, etc.
void	destroyScroller()
long	getDefaultLoadtime()
long	getMaximumMillis()
long	getMinimumMillis()
int	getNumUsedDataBlocks()
java.util.Vector<PamScrollObserver>	getObservers()
int	getPageStep()
long	getRangeMillis()
ScrollerCoupling	getScrollerCoupling()
AbstractScrollManager	getScrollManager()
int	getStepSizeMillis() stepSizeMillis is the resolution of the scroller in milliseconds.
PamDataBlock	getUsedDataBlock(int iBlock) Get a specific data block observed by this scroller.
abstract long	getValueMillis()
boolean	isDataBlockUsed(PamDataBlock dataBlock) See if this scroller is using a particular data block
boolean	isInSpecialList(PamDataBlock pamDataBlock) Check if a data block is within the special data block list.
abstract void	rangesChanged(long setValue) Called when ranges have been changed and tells scroller to go to a particular absolute value.
void	reLoad() Command passed through the the scroll manager telling it reload data.
void	removeAllDataBlocks() Remove all datablocks from the viewed list.
void	removeDataBlock(PamDataBlock dataBlock) Remove a datablock from the viewed list.
void	removeObserver(PamScrollObserver pamScrollObserver) Remove an observer which no longer requires notifications when the scroller moves.
void	setBlockIncrement(long blockIncrement)
void	setPageStep(int pageStep)
void	setRangeMillis(long minimumMillis, long maximumMillis, boolean notify) Set the range of the currently loaded data and optionally notify other scrollers.
void	setScrollerCoupling(ScrollerCoupling scrollerCoupling)
void	setStepSizeMillis(int stepSizeMillis)
void	setUnitIncrement(long unitIncrement)
void	setValueMillis(long valueMillis)
void	setVisibleAmount(long visibleAmount)
void	uncoupleScroller() Remove the scroller from it's coupling.
abstract void	valueSetMillis(long valueMillis) Called when a new position has been set

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractPamScroller

public AbstractPamScroller(java.lang.String name,
                   int orientation,
                   int stepSizeMillis,
                   long defaultLoadTime,
                   boolean hasMenu)

Method Detail

destroyScroller

public void destroyScroller()

addObserver

public void addObserver(PamScrollObserver pamScrollObserver)

Ad an observer that will receive notifications when the the scroller moves.

Parameters:

pamScrollObserver -

removeObserver

public void removeObserver(PamScrollObserver pamScrollObserver)

Remove an observer which no longer requires notifications when the scroller moves.

Parameters:

pamScrollObserver -

addDataBlock

public void addDataBlock(PamDataBlock dataBlock)

Add a datablock to the list for this scroller.

When the scroller is moved, data from data blocks in this list will re read from the database and binary stores. Other data will not be read.

Parameters:

dataBlock - a PamDataBlock

removeDataBlock

public void removeDataBlock(PamDataBlock dataBlock)

Remove a datablock from the viewed list.

Parameters:

dataBlock - a PamDataBlock

removeAllDataBlocks

public void removeAllDataBlocks()

Remove all datablocks from the viewed list.

isDataBlockUsed

public boolean isDataBlockUsed(PamDataBlock dataBlock)

See if this scroller is using a particular data block

Parameters:

dataBlock - a Pamguard data block

Returns:

true if it's being used.

anotherScrollerMovedInner

public abstract void anotherScrollerMovedInner(long newValue)

Another managed scroller moved it's position

Parameters:

newValue - new value in millis

anotherScrollerMovedOuter

public void anotherScrollerMovedOuter(long newMin,
                             long newMax)

Another managed scroller moved its outer position - will cause new data to be loaded.

Parameters:

newMin -

newMax -

getMinimumMillis

public long getMinimumMillis()

Returns:

the minimumMillis

getMaximumMillis

public long getMaximumMillis()

Returns:

the maximumMillis

getRangeMillis

public long getRangeMillis()

Returns:

the difference between getMaximumMills and getMinimumMillis

setRangeMillis

public void setRangeMillis(long minimumMillis,
                  long maximumMillis,
                  boolean notify)

Set the range of the currently loaded data and optionally notify other scrollers.

Parameters:

minimumMillis - minimum time in milliseconds

maximumMillis - maximum time in milliseconds

notify - notify the rangesChanged function.

setVisibleAmount

public void setVisibleAmount(long visibleAmount)

Parameters:

visibleAmount - the visibleAmount to set in millis

rangesChanged

public abstract void rangesChanged(long setValue)

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

Parameters:

setValue -

reLoad

public void reLoad()

Command passed through the the scroll manager telling it reload data.

getValueMillis

public abstract long getValueMillis()

Returns:

the valueMillis

setValueMillis

public final void setValueMillis(long valueMillis)

Parameters:

valueMillis - the valueMillis to set

valueSetMillis

public abstract void valueSetMillis(long valueMillis)

Called when a new position has been set

Parameters:

valueMillis - new scroll value in milliseconds

getStepSizeMillis

public int getStepSizeMillis()

stepSizeMillis is the resolution of the scroller in milliseconds.

For displays which will only ever display a short amount of data this can be one, however for longer displays this should be 1000 (a second) or more to avoid wrap around of the 32 bit integers used to control the actual scroll bar.

Returns:

the stepSizeMillis

setStepSizeMillis

public void setStepSizeMillis(int stepSizeMillis)

Parameters:

stepSizeMillis - the stepSizeMillis to set

setBlockIncrement

public void setBlockIncrement(long blockIncrement)

Parameters:

blockIncrement - the blockIncrement to set in millis

setUnitIncrement

public void setUnitIncrement(long unitIncrement)

Parameters:

unitIncrement - the unitIncrement to set in millis

getObservers

public java.util.Vector<PamScrollObserver> getObservers()

Returns:

the observers

getPageStep

public int getPageStep()

Returns:

the pageStep

setPageStep

public void setPageStep(int pageStep)

Parameters:

pageStep - the pageStep to set

getDefaultLoadtime

public long getDefaultLoadtime()

getScrollManager

public AbstractScrollManager getScrollManager()

Returns:

the scrollManager

coupleScroller

public ScrollerCoupling coupleScroller(java.lang.String couplingName)

Couple this scroller to another scroller so that both have exactly the same behaviour, load the same data period, move their scrolls together, etc.

Scollers are coupled by name so that they don't necessarily need to find references to each other in the code. These names can be anything by measures should be taken to ensure that they are going to be unique, for example by using module names as part of the coupling name.

Parameters:

couplingName - name of the coupling

Returns:

number of other scrollers in this coupling

uncoupleScroller

public void uncoupleScroller()

Remove the scroller from it's coupling.

getScrollerCoupling

public ScrollerCoupling getScrollerCoupling()

setScrollerCoupling

public void setScrollerCoupling(ScrollerCoupling scrollerCoupling)

coupledScrollerChanged

public void coupledScrollerChanged(AbstractPamScroller scroller)

Called when a scroller which is coupled to this scroller changes in any way.

Parameters:

scroller - coupled scroller which changes.

getNumUsedDataBlocks

public int getNumUsedDataBlocks()

Returns:

the number of data blocks observed by this scroller

getUsedDataBlock

public PamDataBlock getUsedDataBlock(int iBlock)

Get a specific data block observed by this scroller.

Parameters:

iBlock - block index

Returns:

reference to an observed datablock

isInSpecialList

public boolean isInSpecialList(PamDataBlock pamDataBlock)

Check if a data block is within the special data block list.

Parameters:

pamDataBlock -

Returns: