StockTicker class

Inheritance Movie Clip > UIObject class > UIComponent class > StockTicker (see flash help for documentation on parent classes).

ActionScript Class Name flextnet.components.StockTicker

Each component class has a version property, which is a class property. Class properties are available only on the class itself. The version property returns a string that indicates the version of the component. To access this property, use the following code:

trace(flextnet.components.StockTicker.version);

Note: The code trace(myTickerInstance.version); returns undefined.

Method summary for the StockTicker class

Besides methods in parent classes, you can call the following methods on a StockTicker component:

Method	Description
`getStockInfo()`	Retrieves all the current supplied info for a stock symbol.
`getStockTextDisplay()`	Returns the display movie clip related to the specified symbol.
`getSymbolProperties()`	Returns the properties for displaying the symbol and url link.
`pauseTicker()`	Stops the stock quotes scrolling.
`playTicker()`	Resumes the stock quotes scrolling.
`setSymbolProperties()`	Sets properties for displaying the symbol and url link.

Property summary for the StockTicker class

These are the properties of the StockTicker class:

Property	Description
`alwaysUseFontStyles`	Specifies whether to use user supplied font styles on top of quoteDisplay text.
`border`	Specifies whether to display a black border around the ticker.
`changeColor_down`	Color for Change and Percentage change fields when a stock price is dropping.
`changeColor_up`	Color for Change and Percentage change fields when a stock price is increasing.
`changeFormat`	Read-only TextFormat for stock change information TextField.
`direction`	Specifies whether quotes are scrolled vertically or horizontally.
`embed_Fonts`	Short-cut for setting the 'embedFonts' style as true or false.
`font_Color`	Short-cut for setting the 'color' style.
`font_Family`	Short-cut for setting the 'fontFamily' style.
`font_Size`	Short-cut for setting the 'fontSize' style.
`font_Weight`	Short-cut for setting the 'fontWeight' style as "bold" or "none".
`pauseOnClick`	Boolean value indicating whether the ticker is paused/restarted when user clicks inside the display.
`quoteDisplay`	MovieClip used to display stock quote information.
`quoteRetriever`	Custom stock quote retriever derived from the StockQuoteRetriever class.
`retrieverScriptURL`	Path to server side script to retrieve stock data.
`roundDecimals`	Indicates whether numeric values are rounded off.
`scrollSpeed`	The number of pixels the quotes scroll on each frame.
`separationDistance`	The number of pixels between symbol display information movie clips.
`separator`	MovieClip used as a separator between quotes.
`showChangeColors`	Boolean value indicating whether a stock's change values are shown in green or red.
`symbols`	Array of symbols to grab stock info for.
`updateInterval`	Number of seconds to delay between updates of stock information.

Event summary for the StockTicker class

These are the events of the StockTicker class:

Events	Description
`stockUpdate`	Triggered when new stock info has been successfully retrieved from the web service.