echopoint
Class NewsTicker

java.lang.Object
  nextapp.echo.AbstractComponent
      nextapp.echo.Panel
          echopoint.Panel
              echopoint.ScrollablePanel
                  echopoint.NewsTicker

All Implemented Interfaces:

LayoutManageable, Borderable, Clippable, MouseCursorable, Positionable, Scrollable, ScrollableContainer, ReflectionSetter, java.io.Serializable, Component

public class NewsTicker
extends ScrollablePanel

The NewsTicker class provides a Component that scrolls its child components in a panel according to user defined parameters.

See Also:

Serialized Form

Nested Class Summary

static class

NewsTicker.NestedStyleInfo Nested public static StyleInfo class.

Field Summary

protected int	delay
static java.lang.String	DELAY_CHANGED_PROPERTY Property Change Names
protected int	direction
static java.lang.String	DIRECTION_CHANGED_PROPERTY
static java.lang.String	PIXELS_PER_CHANGED_PROPERTY
protected int	pixelsPerScroll
static java.lang.String	STYLE_DELAY A style constant for the Delay property.
static java.lang.String	STYLE_DIRECTION A style constant for the Direction property.
static java.lang.String	STYLE_PIXELS_PER_SCROLL A style constant for the PixelsPerScroll property.

Fields inherited from class echopoint.ScrollablePanel

DEFAULT_POSITONABLE_POLICY, DEFAULT_SCROLLBAR_POLICY

Fields inherited from class nextapp.echo.Panel

DEFAULT_INSETS, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, INSETS_CHANGED_PROPERTY, STYLE_HORIZONTAL_ALIGNMENT, STYLE_INSETS, STYLE_VERTICAL_ALIGNMENT, VERTICAL_ALIGNMENT_CHANGED_PROPERTY

Fields inherited from interface echopoint.positionable.ScrollableContainer

HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, INSETS_CHANGED_PROPERTY, STYLE_HORIZONTAL_ALIGNMENT, STYLE_INSETS, STYLE_VERTICAL_ALIGNMENT, VERTICAL_ALIGNMENT_CHANGED_PROPERTY

Fields inherited from interface echopoint.positionable.Scrollable

HEIGHT_CHANGED_PROPERTY, SCROLL_BAR_X_CHANGED_PROPERTY, SCROLL_BAR_Y_CHANGED_PROPERTY, SCROLLBAR_POLICY_CHANGED_PROPERTY, SCROLLBARS_ALWAYS, SCROLLBARS_AUTO, SCROLLBARS_CLIPHIDE, SCROLLBARS_NEVER, STYLE_HEIGHT, STYLE_SCROLL_BAR_POLICY, STYLE_WIDTH, UNDEFINED, undefinedSymbolic, WIDTH_CHANGED_PROPERTY

Fields inherited from interface echopoint.positionable.Positionable

POSITION_CHANGED_PROPERTY, POSITIONING_ABSOLUTE, POSITIONING_FLOW, POSITIONING_RELATIVE, positioningSymbolics, STYLE_BOTTOM, STYLE_LEFT, STYLE_POSITIONING, STYLE_RIGHT, STYLE_TOP, STYLE_ZINDEX, UNDEFINED, undefinedSymbolic

Fields inherited from interface echopoint.positionable.Clippable

CLIP_RECT_CHANGED_PROPERTY, STYLE_CLIP_RECT

Fields inherited from interface echopoint.positionable.Borderable

BORDER_DASHED, BORDER_DOTTED, BORDER_DOUBLE, BORDER_GROOVE, BORDER_INSET, BORDER_NONE, BORDER_OUTSET, BORDER_RIDGE, BORDER_SOLID, borderStyleSymbolics, STYLE_BORDER_COLOR, STYLE_BORDER_SIZE, STYLE_BORDER_STYLE, STYLE_BOTTOM_BORDER_COLOR, STYLE_BOTTOM_BORDER_SIZE, STYLE_BOTTOM_BORDER_STYLE, STYLE_LEFT_BORDER_COLOR, STYLE_LEFT_BORDER_SIZE, STYLE_LEFT_BORDER_STYLE, STYLE_RIGHT_BORDER_COLOR, STYLE_RIGHT_BORDER_SIZE, STYLE_RIGHT_BORDER_STYLE, STYLE_TOP_BORDER_COLOR, STYLE_TOP_BORDER_SIZE, STYLE_TOP_BORDER_STYLE

Fields inherited from interface echopoint.layout.LayoutManageable

LAYOUT_MANAGED_CHANGED_PROPERTY

Fields inherited from interface echopoint.positionable.MouseCursorable

borderStyleSymbolics, CURSOR_AUTO, CURSOR_CROSSHAIR, CURSOR_CUSTOM_URI, CURSOR_DEFAULT, CURSOR_E_RESIZE, CURSOR_HELP, CURSOR_MOVE, CURSOR_N_RESIZE, CURSOR_NE_RESIZE, CURSOR_NW_RESIZE, CURSOR_POINTER, CURSOR_S_RESIZE, CURSOR_SE_RESIZE, CURSOR_SW_RESIZE, CURSOR_TEXT, CURSOR_W_RESIZE, CURSOR_WAIT, STYLE_MOUSE_CURSOR, STYLE_MOUSE_CURSOR_URI

Fields inherited from interface nextapp.echo.Component

BACKGROUND_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FONT_CHANGED_PROPERTY, FOREGROUND_CHANGED_PROPERTY, IDENTIFIER_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, MODEL_CHANGED_PROPERTY, SELECTABLE_CHANGED_PROPERTY, STYLE_BACKGROUND, STYLE_FONT, STYLE_FOREGROUND, UPDATE_PROPERTY, VISIBLE_CHANGED_PROPERTY

Constructor Summary

NewsTicker()
Creates a NewsTicker that is 300 pixels by 300 pixels.

NewsTicker(LayoutManager layoutManager)
Constructs a NewsTicker with a LayoutManager that is 300 pixels by 300 pixels.

Method Summary

void	applyStyle(Style style) Applies the provided style to the component.
int	getDelay() Returns the delay, in milliseconds
int	getDirection() Returns the direction of the NewsTicker text.
int	getPixelsPerScroll() Returns the pixelsPerScroll.
java.lang.Object	set(java.lang.reflect.Field field, java.lang.Object newValue) Called to save the old value of a field, set in a new value and return the old value of a field.
void	setDelay(int delay) Sets the delay in milliseconds.
void	setDirection(int newDirection) Sets the direction of the NewsTicker text.
void	setPixelsPerScroll(int pixelsPerScroll) Sets the pixelsPerScroll.

Methods inherited from class echopoint.ScrollablePanel

clearPositioning, getBottom, getClipRect, getHeight, getLeft, getPositioning, getRight, getScreenHeight, getScreenWidth, getScrollBarPolicy, getScrollBarX, getScrollBarY, getTop, getWidth, getzIndex, isPositioned, setBottom, setClipRect, setClipRect, setClipRect, setHeight, setLeft, setPositioning, setRight, setScrollBarPolicy, setScrollBarX, setScrollBarY, setTop, setWidth, setzIndex

Methods inherited from class echopoint.Panel

add, add, add, add, addImpl, getBorderColor, getBorderSize, getBorderStyle, getBottomBorderColor, getBottomBorderSize, getBottomBorderStyle, getLayoutManager, getLeftBorderColor, getLeftBorderSize, getLeftBorderStyle, getMouseCursor, getMouseCursorURI, getRightBorderColor, getRightBorderSize, getRightBorderStyle, getTopBorderColor, getTopBorderSize, getTopBorderStyle, remove, remove, setBorderColor, setBorderSize, setBorderStyle, setBottomBorderColor, setBottomBorderSize, setBottomBorderStyle, setLayoutManager, setLeftBorderColor, setLeftBorderSize, setLeftBorderStyle, setMouseCursor, setMouseCursorURI, setRightBorderColor, setRightBorderSize, setRightBorderStyle, setTopBorderColor, setTopBorderSize, setTopBorderStyle

Methods inherited from class nextapp.echo.Panel

getHorizontalAlignment, getInsets, getVerticalAlignment, setHorizontalAlignment, setInsets, setVerticalAlignment

Methods inherited from class nextapp.echo.AbstractComponent

addHierarchyListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getClientId, getComponent, getComponentCount, getComponents, getEchoInstance, getFont, getForeground, getIdentifier, getListenerList, getLocale, getParent, indexOf, init, isAncestorOf, isDifferent, isEnabled, isFocused, isRecursivelyVisible, isRegistered, isSelectableForScriptRecorder, isShowing, isVisible, processHierarchyEvent, removeAll, removeHierarchyListener, removePropertyChangeListener, setBackground, setClientId, setEnabled, setFocused, setFont, setForeground, setIdentifier, setLocale, setParent, setRegistered, setSelectableForScriptRecorder, setVisible, update, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface echopoint.positionable.ScrollableContainer

getHorizontalAlignment, getInsets, getVerticalAlignment, setHorizontalAlignment, setInsets, setVerticalAlignment

Methods inherited from interface echopoint.positionable.Borderable

getBorderColor, getBorderSize, getBorderStyle, getBottomBorderColor, getBottomBorderSize, getBottomBorderStyle, getLeftBorderColor, getLeftBorderSize, getLeftBorderStyle, getRightBorderColor, getRightBorderSize, getRightBorderStyle, getTopBorderColor, getTopBorderSize, getTopBorderStyle, setBorderColor, setBorderSize, setBorderStyle, setBottomBorderColor, setBottomBorderSize, setBottomBorderStyle, setLeftBorderColor, setLeftBorderSize, setLeftBorderStyle, setRightBorderColor, setRightBorderSize, setRightBorderStyle, setTopBorderColor, setTopBorderSize, setTopBorderStyle

Methods inherited from interface echopoint.layout.LayoutManageable

add, add, add, add, getLayoutManager, remove, remove, setLayoutManager

Field Detail

STYLE_DELAY

public static final java.lang.String STYLE_DELAY

A style constant for the Delay property. Values of this key must be of type int.

See Also:

Constant Field Values

STYLE_PIXELS_PER_SCROLL

public static final java.lang.String STYLE_PIXELS_PER_SCROLL

A style constant for the PixelsPerScroll property. Values of this key must be of type int.

See Also:

Constant Field Values

STYLE_DIRECTION

public static final java.lang.String STYLE_DIRECTION

A style constant for the Direction property. Values of this key must be of type int.

See Also:

Constant Field Values

DELAY_CHANGED_PROPERTY

public static final java.lang.String DELAY_CHANGED_PROPERTY

Property Change Names

See Also:

Constant Field Values

PIXELS_PER_CHANGED_PROPERTY

public static final java.lang.String PIXELS_PER_CHANGED_PROPERTY

See Also:

Constant Field Values

DIRECTION_CHANGED_PROPERTY

public static final java.lang.String DIRECTION_CHANGED_PROPERTY

See Also:

Constant Field Values

delay

protected int delay

pixelsPerScroll

protected int pixelsPerScroll

direction

protected int direction

Constructor Detail

NewsTicker

public NewsTicker()

Creates a NewsTicker that is 300 pixels by 300 pixels.

NewsTicker

public NewsTicker(LayoutManager layoutManager)

Constructs a NewsTicker with a LayoutManager that is 300 pixels by 300 pixels.

Method Detail

applyStyle

public void applyStyle(Style style)

Applies the provided style to the component. The base nextapp.echo.Component style names can be used as well.

Specified by:

applyStyle in interface Borderable

Specified by:

applyStyle in interface Clippable

Specified by:

applyStyle in interface MouseCursorable

Specified by:

applyStyle in interface Positionable

Specified by:

applyStyle in interface Scrollable

Specified by:

applyStyle in interface Component

Overrides:

applyStyle in class ScrollablePanel

Parameters:

style - The style object from which to retrieve properties for this Component.

See Also:

Borderable.applyStyle(nextapp.echo.Style)

getDelay

public int getDelay()

Returns the delay, in milliseconds

Returns:

long

getDirection

public int getDirection()

Returns the direction of the NewsTicker text. This can be summarised as "the direction towards which the text is moving".

Returns:

the direction of the NewsTicker text, one of the following values:

• EchoConstants.TOP
• EchoConstants.BOTTOM
• EchoConstants.LEFT
• EchoConstants.RIGHT

getPixelsPerScroll

public int getPixelsPerScroll()

Returns the pixelsPerScroll.

Returns:

int

setDelay

public void setDelay(int delay)

Sets the delay in milliseconds.

Parameters:

delay - The delay, in milliseconds, to set

setDirection

public void setDirection(int newDirection)

Sets the direction of the NewsTicker text. This can be summarised as "the direction towards which the text is moving".

This can be one of the following values:

• EchoConstants.TOP
• EchoConstants.BOTTOM
• EchoConstants.LEFT
• EchoConstants.RIGHT

setPixelsPerScroll

public void setPixelsPerScroll(int pixelsPerScroll)

Sets the pixelsPerScroll.

Parameters:

pixelsPerScroll - The pixelsPerScroll to set

set

public java.lang.Object set(java.lang.reflect.Field field,
                            java.lang.Object newValue)
                     throws java.lang.Exception

Description copied from interface: ReflectionSetter

Called to save the old value of a field, set in a new value and return the old value of a field. This interface allows a field set operation to be "delegated" back into the class that has permission to perform the field set.

 public Object set(Field f, Object newValue) throws Exception {
      Object oldValue = f.get(this);
      f.set(this,newValue);
      return oldValue;
 }
 

Specified by:

set in interface ReflectionSetter

Overrides:

set in class ScrollablePanel

Parameters:

field - - the field to be set

newValue - - the new value to be set

Returns:

the oldValue of the field

Throws:

java.lang.IllegalAccessException

java.lang.IllegalArgumentException

java.lang.NullPointerException

java.lang.Exception

See Also:

ReflectionSetter.set(Field, Object)