All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class ejmf.toolkit.gui.tickertape.TickerTape

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Panel
                           |
                           +----ejmf.toolkit.gui.tickertape.TickerTape

public class TickerTape
extends Panel
implements Runnable
The Tickertape class is a generic tickertape that slowly scrolls text across the viewable window. The TickerTape class provides a the basis of the Multi-Image Player.


Constructor Index

 o TickerTape(String)
Constructs a TickerTape to display the given message.

Method Index

 o appendMessage(String)
Append the given message to the current message being displayed in this TickerTape.
 o getLoop()
Returns a boolean indicating whether the TickerTape's message will loop.
 o getMessage()
Get the message being displayed in this TickerTape.
 o getPreferredSize()
Returns the preferred size of the TickerTape.
 o getRate()
Gets the rate for this TickerTape.
 o getShadow()
Get the color of the shadow.
 o getShadowEnabled()
Gets the status of the TickerTape's shadow.
 o getShadowXOffset()
Gets the number of pixels ofsetting the message from it's shadow on the X-plain.
 o getShadowYOffset()
Gets the number of pixels ofsetting the message from it's shadow on the X-plain.
 o invalidate()
 o invalidateImage()
Forces the message image to be reconstructed within the TickerTape.
 o invalidateMetrics()
Forces the message image to be reconstructed within the TickerTape.
 o paint(Graphics)
Paint the TickerTape.
 o printable(String)
Converts all control characters of a String to spaces.
 o run()
Called when the TickerTape is started with start().
 o setBackground(Color)
Gets the font of this TickerTape.
 o setFont(Font)
Sets the font of this TickerTape.
 o setForeground(Color)
Sets the text color of this TickerTape.
 o setLoop(boolean)
Enable/disable the looping of the TickerTape's text.
 o setMessage(String)
Set the message to be displayed by this TickerTape.
 o setRate(int)
Sets the rate for this TickerTape.
 o setShadow(Color)
Set the color of the shadow.
 o setShadowEnabled(boolean)
Enable/disable the display of the TickerTape's shadow.
 o setShadowXOffset(int)
Set the number of pixels ofsetting the message from it's shadow on the X-plain.
 o setShadowYOffset(int)
Set the number of pixels ofsetting the message from it's shadow on the Y-plain.
 o start()
Start the TickerTape.
 o stop()
Stop the TickerTape.
 o update(Graphics)

Constructors

 o TickerTape
 public TickerTape(String message)
Constructs a TickerTape to display the given message.

Methods

 o setMessage
 public void setMessage(String newMessage)
Set the message to be displayed by this TickerTape.

 o appendMessage
 public void appendMessage(String message)
Append the given message to the current message being displayed in this TickerTape.

 o getMessage
 public String getMessage()
Get the message being displayed in this TickerTape.

 o setShadowXOffset
 public void setShadowXOffset(int shadowX)
Set the number of pixels ofsetting the message from it's shadow on the X-plain.

 o getShadowXOffset
 public int getShadowXOffset()
Gets the number of pixels ofsetting the message from it's shadow on the X-plain.

 o setShadowYOffset
 public void setShadowYOffset(int shadowY)
Set the number of pixels ofsetting the message from it's shadow on the Y-plain.

 o getShadowYOffset
 public int getShadowYOffset()
Gets the number of pixels ofsetting the message from it's shadow on the X-plain.

 o setShadow
 public void setShadow(Color shadow)
Set the color of the shadow.

 o getShadow
 public Color getShadow()
Get the color of the shadow.

 o setShadowEnabled
 public void setShadowEnabled(boolean shadowEnabled)
Enable/disable the display of the TickerTape's shadow.

 o getShadowEnabled
 public boolean getShadowEnabled()
Gets the status of the TickerTape's shadow.

 o setLoop
 public void setLoop(boolean loop)
Enable/disable the looping of the TickerTape's text. If true, the message will be repeatedly replayed once it has been shown.

 o getLoop
 public boolean getLoop()
Returns a boolean indicating whether the TickerTape's message will loop.

 o setRate
 public void setRate(int rate)
Sets the rate for this TickerTape.

 o getRate
 public int getRate()
Gets the rate for this TickerTape.

 o setFont
 public void setFont(Font f)
Sets the font of this TickerTape.

Overrides:
setFont in class Component
 o setBackground
 public void setBackground(Color c)
Gets the font of this TickerTape.

Overrides:
setBackground in class Component
 o setForeground
 public void setForeground(Color c)
Sets the text color of this TickerTape.

Overrides:
setForeground in class Component
 o invalidateImage
 public void invalidateImage()
Forces the message image to be reconstructed within the TickerTape.

 o invalidateMetrics
 public void invalidateMetrics()
Forces the message image to be reconstructed within the TickerTape.

 o start
 public synchronized void start()
Start the TickerTape.

 o stop
 public void stop()
Stop the TickerTape.

 o run
 public synchronized void run()
Called when the TickerTape is started with start(). This method should not be called directly.

 o paint
 public synchronized void paint(Graphics g)
Paint the TickerTape.

Overrides:
paint in class Container
 o update
 public void update(Graphics g)
Overrides:
update in class Container
 o getPreferredSize
 public Dimension getPreferredSize()
Returns the preferred size of the TickerTape. By default, it is 4h x h, where h is the height of the TickerTape's font.

Overrides:
getPreferredSize in class Container
 o invalidate
 public void invalidate()
Overrides:
invalidate in class Container
 o printable
 public static String printable(String convert)
Converts all control characters of a String to spaces.

Parameters:
convert - The String to convert.
Returns:
The converted String.

All Packages  Class Hierarchy  This Package  Previous  Next  Index