Packageorg.juicekit.visual.controls
Classpublic class FlareControlBase
InheritanceFlareControlBase Inheritance RendererBase Inheritance mx.core.UIComponent
SubclassesTreeMapControl

The class FlareControlBase provides a common implementation for visual controls based upon the prefure.flare Visualization. The class is only intended to be used as a base implementation for custom controls and is not intended to be directly instantiated.


Public Properties
 PropertyDefined by
 Inheriteddata : Object
Implement the IDataRenderer interface.
RendererBase
 InheritedlistData : BaseListData
Implement the IDropInListItemRenderer interface.
RendererBase
  transitionPeriod : Number
Specifies the animation transition time period in seconds.
FlareControlBase
  vis : Visualization = null
Stores reference to the prefuse.flare Visualization context.
FlareControlBase
Protected Properties
 PropertyDefined by
 InheriteddataPropertyChanged : Boolean = false
Indicated whether the data property was changed.
RendererBase
Public Methods
 MethodDefined by
  
FlareControlBase()
Constructor.
FlareControlBase
Protected Methods
 MethodDefined by
  
addEventListeners():void
Add any event listeners to the Visualization instance.
FlareControlBase
  
asFlareProperty(propertyName:String):String
Return a flare-style data property string.
FlareControlBase
  
calcPaddedBounds(w:Number, h:Number):Rectangle
Calculates a Rectangle inset by any padding styles.
FlareControlBase
 Inherited
commitProperties():void
Reset the dataPropertyChanged and invalidate the display list.
RendererBase
  
initVisualization():void
Initialize the control's prefuse.flare Visualization instance.
FlareControlBase
  
makeVisualization():Visualization
Create a prefuse.flare Visualization instance.
FlareControlBase
  
numToAlphaBits(alpha:Number):uint
[static] Helper function to produce high-order alpha bits from a Number ranging from 0.0 to 1.0 inclusive.
FlareControlBase
  
onMouseOut(event:MouseEvent):void
Handle mouse out events.
FlareControlBase
  
onMouseOver(event:MouseEvent):void
Handle mouse over events.
FlareControlBase
  
removeEventListeners():void
Remove any event listeners from the Visualization instance.
FlareControlBase
  
signalDataMouseEvent(event:MouseEvent):void
Dispatch DataMouseEvent events.
FlareControlBase
  
toARGB(rgbColor:uint, alpha:Number):uint
[static] Convert an RGB color value and alpha specification into a flare compatible ARGB color value.
FlareControlBase
  
updateVisualization():void
Call the update method on the visualization.
FlareControlBase
Events
 EventSummaryDefined by
 Inherited
dataChange
Dispatched when the data property changes.RendererBase
  
end
Dispatched when an animating Visualization update completes the animation Transition FlareControlBase
  
jkDataClick
Dispatched when the user clicks a pointing device over a TreemapControl instance's rectangle.FlareControlBase
  
jkDataDoubleClick
Dispatched when the user clicks a pointing device over a TreemapControl instance's rectangle.FlareControlBase
  
jkDataMouseOut
Dispatched when the user moves a pointing device away from TreemapControl instance's rectangle.FlareControlBase
  
jkDataMouseOver
Dispatched when the user moves a pointing device over a TreemapControl instance's rectangle.FlareControlBase
  
start
Dispatched when an animating Visualization update begins the animation Transition FlareControlBase
Styles
 StyleDescriptionDefined by
  
backgroundColor
Type: uint   Format: Color   CSS Inheritance: no
Specifies the opaque background color of the control. The default value is undefined. If this style is undefined, the control has a transparent background. 		FlareControlBase
  
paddingBottom
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the component's bottom border and the bottom edge of its content area. The default value is 0.		FlareControlBase
  
paddingLeft
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the component's left border and the left edge of its content area. The default value is 0.		FlareControlBase
  
paddingRight
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the component's right border and the right edge of its content area. The default value is 0.		FlareControlBase
  
paddingTop
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the component's top border and the top edge of its content area. The default value is 0.		FlareControlBase
Property detail
transitionPeriodproperty
transitionPeriod:Number  [read-write]

Specifies the animation transition time period in seconds. The default value is NaN which disables animation.

The default value is NaN.

This property can be used as the source for data binding.

Implementation
    public function get transitionPeriod():Number
    public function set transitionPeriod(value:Number):void
visproperty 
public var vis:Visualization = null

Stores reference to the prefuse.flare Visualization context.

Constructor detail
FlareControlBase()constructor
public function FlareControlBase()

Constructor.

Method detail
addEventListeners()method
protected function addEventListeners():void

Add any event listeners to the Visualization instance.

asFlareProperty()method 
protected function asFlareProperty(propertyName:String):String

Return a flare-style data property string.

Parameters
propertyName:String

Returns
String
calcPaddedBounds()method 
protected function calcPaddedBounds(w:Number, h:Number):Rectangle

Calculates a Rectangle inset by any padding styles.

Parameters
w:Number — Is the maximum width before any padding is subtracted.
 
h:Number — Is the maximum height before any padding is subtracted.

Returns
Rectangle — Returns a rectangle inset by the padding styles.
initVisualization()method 
protected function initVisualization():void

Initialize the control's prefuse.flare Visualization instance. Derived classes should override this function to add operators to the vis object.

makeVisualization()method 
protected function makeVisualization():Visualization

Create a prefuse.flare Visualization instance.

Returns
Visualization — Returns a prefuse.flare Visualization instance.
numToAlphaBits()method 
protected static function numToAlphaBits(alpha:Number):uint

Helper function to produce high-order alpha bits from a Number ranging from 0.0 to 1.0 inclusive.

Parameters
alpha:Number — Is a Number value ranging from 0.0 to 1.0 inclusive where 0.0 is transparent and 1.0 is opaque.

Returns
uint — Returns high-order byte encoding of the alpha value.
onMouseOut()method 
protected function onMouseOut(event:MouseEvent):void

Handle mouse out events.

Parameters
event:MouseEvent
onMouseOver()method 
protected function onMouseOver(event:MouseEvent):void

Handle mouse over events.

Parameters
event:MouseEvent
removeEventListeners()method 
protected function removeEventListeners():void

Remove any event listeners from the Visualization instance.

signalDataMouseEvent()method 
protected function signalDataMouseEvent(event:MouseEvent):void

Dispatch DataMouseEvent events.

Parameters
event:MouseEvent
toARGB()method 
protected static function toARGB(rgbColor:uint, alpha:Number):uint

Convert an RGB color value and alpha specification into a flare compatible ARGB color value.

Parameters
rgbColor:uint — Is a uint holding the red, green, and blue bytes in the lower three bytes.
 
alpha:Number — Is a Number value ranging from 0.0 to 1.0 inclusive where 0.0 is transparent and 1.0 is opaque.

Returns
uint — Returns a flare compatible ARGB color uint.
updateVisualization()method 
protected function updateVisualization():void

Call the update method on the visualization. The transitionPeriod property is used to determine whether animation is appropriate. If animation is appropriate, this method will signal TransitionEvent.START and TransitionEvent.END to any listeners.

Event detail
endevent 
Event object type: flare.animate.TransitionEvent

Dispatched when an animating Visualization update completes the animation Transition

jkDataClickevent  
Event object type: org.juicekit.events.DataMouseEvent

Dispatched when the user clicks a pointing device over a TreemapControl instance's rectangle.

jkDataDoubleClickevent  
Event object type: org.juicekit.events.DataMouseEvent

Dispatched when the user clicks a pointing device over a TreemapControl instance's rectangle.

jkDataMouseOutevent  
Event object type: org.juicekit.events.DataMouseEvent

Dispatched when the user moves a pointing device away from TreemapControl instance's rectangle.

jkDataMouseOverevent  
Event object type: org.juicekit.events.DataMouseEvent

Dispatched when the user moves a pointing device over a TreemapControl instance's rectangle.

startevent  
Event object type: flare.animate.TransitionEvent

Dispatched when an animating Visualization update begins the animation Transition