Packagecom.lightstreamer.as_client.item_renderers
Classpublic class HighlightCellItemRenderer
InheritanceHighlightCellItemRenderer Inheritance mx.controls.Label
Implementsmx.core.IFactory

ItemRenderer class to be used to highlight cells on value changes. Some configuration is needed to have a visual effect. The provided visual effect consists of the following sequence:


Public Properties
 PropertyDefined by
  alphas : Array = null
An array of alpha values for the corresponding colors in the colors array; valid values are 0 to 1.
HighlightCellItemRenderer
  coldStyles : *
Styles to be applied whenever a cell passes from a "hot" state to an "cold" state.
HighlightCellItemRenderer
  colors : Array = null
An array of RGB hexadecimal color values to be applied in the hot state.
HighlightCellItemRenderer
  fadeTime : uint
The duration of the fade effect (in milliseconds) that is applied to pass from "hot" to "cold" state.
HighlightCellItemRenderer
  gradientType : String
A value from the GradientType class that specifies which gradient type to use: GradientType.LINEAR or GradientType.RADIAL.
HighlightCellItemRenderer
  hotStyles : *
Styles to be applied whenever a cell passes from a "cold" state to a "hot" state.
HighlightCellItemRenderer
  hotTime : uint = 0
The duration of the "hot" state (in milliseconds) after an update has been received.
HighlightCellItemRenderer
  ratios : Array = null
An array of color distribution ratios; valid values are from 0 to 255.
HighlightCellItemRenderer
  text : String
[write-only]
HighlightCellItemRenderer
Protected Properties
 PropertyDefined by
  fadeEffect : Fade = null
The fade effect that is applied to pass from "hot" to "cold" state.
HighlightCellItemRenderer
Public Methods
 MethodDefined by
  
clear():void
Move the cell to its cold state.
HighlightCellItemRenderer
  
newInstance():*
HighlightCellItemRenderer
Protected Methods
 MethodDefined by
  
fillCell():void
The method that is responsible of the colouring of the cell.
HighlightCellItemRenderer
  
formatValue(newVal:String, oldVal:String):String
A formatting method that could be overridden to change the value contained in the cell.
HighlightCellItemRenderer
Property detail
alphasproperty
public var alphas:Array = null

An array of alpha values for the corresponding colors in the colors array; valid values are 0 to 1. If the value is lower than 0, the default is 0. If the value is greater than 1, the default is 1.

coldStylesproperty 
public var coldStyles:*

Styles to be applied whenever a cell passes from a "hot" state to an "cold" state. Each name in this object should correspond to the name of an HTML stylesheet attribute; the DOM attribute name should be used, not the CSS name (e.g. "fontWeight" is accepted, while "font-weight" is not). The value should be a valid value for the attribute name.

colorsproperty 
public var colors:Array = null

An array of RGB hexadecimal color values to be applied in the hot state. You can specify up to 15 colors. For each color, be sure you specify a corresponding value in the alphas and ratios properties.

See also

flash.display.Graphics.beginGradientFill()
http://livedocs.adobe.com/flex/201/langref/flash/display/Graphics.html#beginGradientFill()
fadeEffectproperty 
protected var fadeEffect:Fade = null

The fade effect that is applied to pass from "hot" to "cold" state.

fadeTimeproperty 
fadeTime:uint  [read-write]

The duration of the fade effect (in milliseconds) that is applied to pass from "hot" to "cold" state. (Default: 0).

Implementation
    public function get fadeTime():uint
    public function set fadeTime(value:uint):void
gradientTypeproperty 
public var gradientType:String

A value from the GradientType class that specifies which gradient type to use: GradientType.LINEAR or GradientType.RADIAL.

hotStylesproperty 
public var hotStyles:*

Styles to be applied whenever a cell passes from a "cold" state to a "hot" state. Each name in this object should correspond to the name of an HTML stylesheet attribute; the DOM attribute name should be used, not the CSS name (e.g. "fontWeight" is accepted, while "font-weight" is not). The value should be a valid value for the attribute name.

hotTimeproperty 
public var hotTime:uint = 0

The duration of the "hot" state (in milliseconds) after an update has been received. (Default: 0).

ratiosproperty 
public var ratios:Array = null

An array of color distribution ratios; valid values are from 0 to 255. This value defines the percentage of the width where the color is sampled at 100%. The value 0 represents the left-hand position in the gradient box, and 255 represents the right-hand position in the gradient box.

textproperty 
text:String  [write-only]

Implementation
    public function set text(value:String):void
Method detail
clear()method
public function clear():void

Move the cell to its cold state.

fillCell()method 
protected function fillCell():void

The method that is responsible of the colouring of the cell. If you override this method don't forget to place "this.alpha = 1;" in your code.

formatValue()method 
protected function formatValue(newVal:String, oldVal:String):String

A formatting method that could be overridden to change the value contained in the cell. Default implementation does nothing.

Parameters
newVal:String
 
oldVal:String

Returns
String
newInstance()method 
public function newInstance():*

Returns
*



Lightstreamer Flex client 1.1 API