com.swingleddisplay.elements
Class ArrowToken

java.lang.Object
  com.swingleddisplay.elements.Token
      com.swingleddisplay.elements.ArrowToken

public final class ArrowToken

extends Token

A token representation of an abstract trend. The upward trend is represented as an arrow pointing up, the constant trend is represented as a horizontal line and the downward trend is represented as an arrow pointing down.

Field Summary

static java.lang.Object	DECREASING Abstract value associated with a downward trend
static java.lang.Object	INCREASING Abstract value associated with an upward trend
static java.lang.Object	UNCHANGED Abstract value associated with a constant trend

Constructor Summary

ArrowToken()
Creates an ArrowToken with a constant trend

ArrowToken(ColorModel colorModel)
Creates an ArrowToken with a constant trend and a custom ColorModel

Method Summary

java.lang.Object	getArrowType() Returns the trend of this ArrowToken
java.lang.String	getDisplayValue() Unused.
void	setValue(java.lang.Object value) Sets the token's value, which its defined by a trend.

Methods inherited from class com.swingleddisplay.elements.Token

getColorModel, setColorModel

Methods inherited from class java.lang.Object

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

Field Detail

INCREASING

public static final java.lang.Object INCREASING

Abstract value associated with an upward trend

DECREASING

public static final java.lang.Object DECREASING

Abstract value associated with a downward trend

UNCHANGED

public static final java.lang.Object UNCHANGED

Abstract value associated with a constant trend

Constructor Detail

ArrowToken

public ArrowToken()

Creates an ArrowToken with a constant trend

ArrowToken

public ArrowToken(ColorModel colorModel)

Creates an ArrowToken with a constant trend and a custom ColorModel

Parameters:

colorModel - the ColorModel

Method Detail

getArrowType

public java.lang.Object getArrowType()

Returns the trend of this ArrowToken

Returns:

the trend of the ArrowToken

getDisplayValue

public java.lang.String getDisplayValue()

Unused. This type of token has abstract values which are not represented as Strings.

Specified by:

getDisplayValue in class Token

Returns:

the token's String representation

See Also:

Token.getDisplayValue()

setValue

public void setValue(java.lang.Object value)

Sets the token's value, which its defined by a trend.

Specified by:

setValue in class Token

Parameters:

value - the token's value

See Also:

Token.setValue(java.lang.Object), INCREASING, UNCHANGED, DECREASING