| Package | org.axiis.core |
| Class | public class AbstractLayout |
| Inheritance | AbstractLayout  flash.events.EventDispatcher |
| Subclasses | BaseLayout |
| Property | Defined By | ||
|---|---|---|---|
| bounds : Rectangle
A rectangle that acts as the bounding area for this layout
| AbstractLayout | ||
| childSprites : Array [read-only]
The AxiisSprites this layout has created to render each item in its dataProvider. | AbstractLayout | ||
| currentDatum : * [read-only]
The item in the dataProvider that the layout is currently rendering. | AbstractLayout | ||
| currentIndex : int [read-only]
The index of the item in the dataProvider that the layout is
currently rendering. | AbstractLayout | ||
| currentLabel : String [read-only]
The label of the item in the dataProvider that the layout is
currently rendering, as determine by taking currentDatum[labelField],
if a labelField is defined. | AbstractLayout | ||
| currentReference : Geometry [read-only]
The geometry that is being used to render the current data item as it
appears after the necessary iterations of the referenceRepeater have
been executed. | AbstractLayout | ||
| currentValue : * [read-only]
The value of the item in the dataProvider that the layout is
currently rendering, as determined by taking currentDatum[dataField],
if a dataField is defined. | AbstractLayout | ||
| dataField : Object
The property within each item in the dataProvider that contains the
field used to determine the value of the item. | AbstractLayout | ||
| dataFilterFunction : Function
This provides a way to further refine a layouts dataProvider by
providing access to a custom filter data filter function. | AbstractLayout | ||
| dataFilterIndex : Number [read-only] | AbstractLayout | ||
| dataItems : Array [read-only]
An array of objects extracted from the dataProvider. | AbstractLayout | ||
| dataProvider : Object
An Array, ArrayCollection, or Object containing the data this layout
should render. | AbstractLayout | ||
| dataTipAnchorPoint : Object
An Object with x and y values used to determine the location of anchored data tips. | AbstractLayout | ||
| dataTipContentClass : IFactory
A ClassFactory that creates the UIComponent that should be used in the data tip for this AxiisSprite. | AbstractLayout | ||
| dataTipContentComponent : UIComponent
A component that gets passed to any data tip. | AbstractLayout | ||
| dataTipLabelFunction : Function
A method used to determine the text that appears in the data tip for
an item rendered by this layout. | AbstractLayout | ||
| dataTipManager : IDataTipManager
The IDataTipManager responsible for laying out data tips for children of this layout. | AbstractLayout | ||
| drawingGeometries : Array
An array of geometries that should be drawn for each item in the data
provider. | AbstractLayout | ||
| fills : Array
A placeholder for fills used within this layout. | AbstractLayout | ||
| height : Number
The height of the layout. | AbstractLayout | ||
| itemCount : int [read-only]
The number of items in the dataProvider. | AbstractLayout | ||
| labelField : Object
The property within each item in the dataProvider that contains the
field used to determine the label for the item. | AbstractLayout | ||
| layouts : Array
The layouts that should be displayed within this layout. | AbstractLayout | ||
| msPerRenderFrame : Number = 50
Determines how long (milliseconds) a layout will spend on a given frame to render X number of datums
| AbstractLayout | ||
| name : String
A string used to identify this layout. | AbstractLayout | ||
| palettes : Array
A placeholder for palettes used within this layout. | AbstractLayout | ||
| parentLayout : AbstractLayout
A reference to the layout that contains this layout. | AbstractLayout | ||
| referenceRepeater : GeometryRepeater
A GeometryRepeater that will be applied to the drawingGeometries once
for each item in the dataProvider. | AbstractLayout | ||
| rendering : Boolean [read-only]
Whether or not this layout is currently in a render cycle. | AbstractLayout | ||
| showDataTips : Boolean
A flag that indicates to DataCanvas that it should listen for mouse
events that signal the need to create a data tip. | AbstractLayout | ||
| states : Array
An array of states that should be applied to this layout. | AbstractLayout | ||
| strokes : Array
A placeholder for strokes used within this layout. | AbstractLayout | ||
| visible : Boolean
Whether or not this layout is visible. | AbstractLayout | ||
| width : Number
The width of the layout. | AbstractLayout | ||
| x : Number
The horizontal position of the top left corner of this layout within
its parent. | AbstractLayout | ||
| y : Number
The vertical position of the top left corner of this layout within
its parent. | AbstractLayout | ||
| Property | Defined By | ||
|---|---|---|---|
| sprite : AxiisSprite
The sprite this layout is currently rendering to. | AbstractLayout | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | AbstractLayout | ||
getProperty(obj:Object, propertyName:Object):*
Uses ObjectUtils.getProperty(this,obj,propertyName) to get a property on an object. | AbstractLayout | ||
getSprite(owner:DataCanvas):Sprite
Returns the Sprite associated with this layout if owner is
in fact the owner of this layout. | AbstractLayout | ||
invalidate():void
Notifies the DataCanvas that this layout needs to be rendered. | AbstractLayout | ||
invalidateDataProvider():void
Iterates over the items in the dataProvider and stores them in
dataItems. | AbstractLayout | ||
registerOwner(dataCanvas:DataCanvas):void
Registers a DisplayObject as the owner of this layout. | AbstractLayout | ||
render(newSprite:AxiisSprite = null):void
Draws this layout to the specified AxiisSprite. | AbstractLayout | ||
| Method | Defined By | ||
|---|---|---|---|
deselectChildren():void
Marks all children as deselected. | AbstractLayout | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when an AxiisSprite is mousedOver. | AbstractLayout | |||
| bounds | property |
bounds:Rectangle [read-write] A rectangle that acts as the bounding area for this layout
This property can be used as the source for data binding.
public function get bounds():Rectangle public function set bounds(value:Rectangle):void| childSprites | property |
childSprites:Array [read-only] The AxiisSprites this layout has created to render each item in its dataProvider.
public function get childSprites():Array| currentDatum | property |
currentDatum:* [read-only] The item in the dataProvider that the layout is currently rendering.
This property can be used as the source for data binding.
public function get currentDatum():*| currentIndex | property |
currentIndex:int [read-only] The index of the item in the dataProvider that the layout is currently rendering.
This property can be used as the source for data binding.
public function get currentIndex():int| currentLabel | property |
currentLabel:String [read-only] The label of the item in the dataProvider that the layout is currently rendering, as determine by taking currentDatum[labelField], if a labelField is defined.
This property can be used as the source for data binding.
public function get currentLabel():String| currentReference | property |
currentReference:Geometry [read-only] The geometry that is being used to render the current data item as it appears after the necessary iterations of the referenceRepeater have been executed.
This property can be used as the source for data binding.
public function get currentReference():Geometry| currentValue | property |
currentValue:* [read-only] The value of the item in the dataProvider that the layout is currently rendering, as determined by taking currentDatum[dataField], if a dataField is defined.
This property can be used as the source for data binding.
public function get currentValue():*| dataField | property |
dataField:Object [read-write] The property within each item in the dataProvider that contains the field used to determine the value of the item.
This property can be used as the source for data binding.
public function get dataField():Object public function set dataField(value:Object):void| dataFilterFunction | property |
public var dataFilterFunction:FunctionThis provides a way to further refine a layouts dataProvider by providing access to a custom filter data filter function. This allows developers to easily visualize subsets of the data without having to change the underlying data structure.
| dataFilterIndex | property |
dataFilterIndex:Number [read-only] public function get dataFilterIndex():Number| dataItems | property |
dataItems:Array [read-only] An array of objects extracted from the dataProvider.
This property can be used as the source for data binding.
public function get dataItems():Array| dataProvider | property |
dataProvider:Object [read-write] An Array, ArrayCollection, or Object containing the data this layout should render.
If this property is Array or ArrayCollection the layout should render each item. If this property is an Object, it should use an array of the object's properties as they are exposed in a for..each loop.
This property can be used as the source for data binding.
public function get dataProvider():Object public function set dataProvider(value:Object):void| dataTipAnchorPoint | property |
dataTipAnchorPoint:Object [read-write] An Object with x and y values used to determine the location of anchored data tips. By using the currentReference, you can update this value during the render cycle.
This property can be used as the source for data binding.
public function get dataTipAnchorPoint():Object public function set dataTipAnchorPoint(value:Object):void| dataTipContentClass | property |
dataTipContentClass:IFactory [read-write] A ClassFactory that creates the UIComponent that should be used in the data tip for this AxiisSprite.
This property can be used as the source for data binding.
public function get dataTipContentClass():IFactory public function set dataTipContentClass(value:IFactory):void| dataTipContentComponent | property |
dataTipContentComponent:UIComponent [read-write] A component that gets passed to any data tip.
This property can be used as the source for data binding.
public function get dataTipContentComponent():UIComponent public function set dataTipContentComponent(value:UIComponent):void| dataTipLabelFunction | property |
dataTipLabelFunction:Function [read-write] A method used to determine the text that appears in the data tip for an item rendered by this layout.
This method takes one argument, the item to determine the label for, and returns a String, the text to show in the data tip.
This property can be used as the source for data binding.
public function get dataTipLabelFunction():Function public function set dataTipLabelFunction(value:Function):void| dataTipManager | property |
dataTipManager:IDataTipManager [read-write] The IDataTipManager responsible for laying out data tips for children of this layout.
public function get dataTipManager():IDataTipManager public function set dataTipManager(value:IDataTipManager):void| drawingGeometries | property |
drawingGeometries:Array [read-write] An array of geometries that should be drawn for each item in the data provider. You can modify these items by using GeometryRepeaters and PropertyModifiers.
This property can be used as the source for data binding.
public function get drawingGeometries():Array public function set drawingGeometries(value:Array):voidSee also
| fills | property |
public var fills:ArrayA placeholder for fills used within this layout. Modifying this array will not have any effect on the rendering of the layout.
This property can be used as the source for data binding.
| height | property |
height:Number [read-write] The height of the layout.
This property can be used as the source for data binding.
public function get height():Number public function set height(value:Number):void| itemCount | property |
itemCount:int [read-only] The number of items in the dataProvider.
This property can be used as the source for data binding.
public function get itemCount():int| labelField | property |
labelField:Object [read-write] The property within each item in the dataProvider that contains the field used to determine the label for the item.
This property can be used as the source for data binding.
public function get labelField():Object public function set labelField(value:Object):void| layouts | property |
layouts:Array [read-write] The layouts that should be displayed within this layout.
This property can be used as the source for data binding.
public function get layouts():Array public function set layouts(value:Array):void| msPerRenderFrame | property |
public var msPerRenderFrame:Number = 50Determines how long (milliseconds) a layout will spend on a given frame to render X number of datums
| name | property |
public var name:StringA string used to identify this layout.
| palettes | property |
public var palettes:ArrayA placeholder for palettes used within this layout. Modifying this array will not have any effect on the rendering of the layout.
This property can be used as the source for data binding.
| parentLayout | property |
parentLayout:AbstractLayout [read-write] A reference to the layout that contains this layout.
This property can be used as the source for data binding.
public function get parentLayout():AbstractLayout public function set parentLayout(value:AbstractLayout):void| referenceRepeater | property |
referenceRepeater:GeometryRepeater [read-write] A GeometryRepeater that will be applied to the drawingGeometries once for each item in the dataProvider.
This property can be used as the source for data binding.
public function get referenceRepeater():GeometryRepeater public function set referenceRepeater(value:GeometryRepeater):void| rendering | property |
rendering:Boolean [read-only] Whether or not this layout is currently in a render cycle. Rendering can take place over several frames. By watching this property you can take an appropriate action handle artifacts for multiframe rendering, such as hiding the layout entirely.
This property can be used as the source for data binding.
public function get rendering():Boolean| showDataTips | property |
showDataTips:Boolean [read-write] A flag that indicates to DataCanvas that it should listen for mouse events that signal the need to create a data tip.
public function get showDataTips():Boolean public function set showDataTips(value:Boolean):void| sprite | property |
sprite:AxiisSprite [read-write] The sprite this layout is currently rendering to.
protected function get sprite():AxiisSprite protected function set sprite(value:AxiisSprite):void| states | property |
states:Array [read-write] An array of states that should be applied to this layout.
As Layouts create children, each child sets up listeners on
itself for the Layout's states' enterStateEvent and
exitStateEvent events. When those events are triggered, the
relevant state's apply and remove methods are called, respectively. This
is usually used to modify the drawingGeometry of the Layout.
public function get states():Array public function set states(value:Array):voidSee also
| strokes | property |
public var strokes:ArrayA placeholder for strokes used within this layout. Modifying this array will not have any effect on the rendering of the layout.
This property can be used as the source for data binding.
| visible | property |
visible:Boolean [read-write] Whether or not this layout is visible. Layouts that are not visible will return from their render methods immediately after they are called without making any changes to the display list.
This property can be used as the source for data binding.
public function get visible():Boolean public function set visible(value:Boolean):void| width | property |
width:Number [read-write] The width of the layout.
This property can be used as the source for data binding.
public function get width():Number public function set width(value:Number):void| x | property |
x:Number [read-write] The horizontal position of the top left corner of this layout within its parent.
This property can be used as the source for data binding.
public function get x():Number public function set x(value:Number):void| y | property |
y:Number [read-write] The vertical position of the top left corner of this layout within its parent.
This property can be used as the source for data binding.
public function get y():Number public function set y(value:Number):void| AbstractLayout | () | Constructor |
public function AbstractLayout()Constructor.
| deselectChildren | () | method |
protected function deselectChildren():voidMarks all children as deselected.
| getProperty | () | method |
public function getProperty(obj:Object, propertyName:Object):*Uses ObjectUtils.getProperty(this,obj,propertyName) to get a property on an object.
Parameters
obj:Object | |
propertyName:Object |
* |
See also
| getSprite | () | method |
public function getSprite(owner:DataCanvas):SpriteReturns the Sprite associated with this layout if owner is in fact the owner of this layout.
Parameters
owner:DataCanvas |
Sprite |
| invalidate | () | method |
public function invalidate():voidNotifies the DataCanvas that this layout needs to be rendered.
| invalidateDataProvider | () | method |
public function invalidateDataProvider():voidIterates over the items in the dataProvider and stores them in dataItems.
If the dataProvider is Array or ArrayCollection dataItems will contain each item. If dataProvider is an Object, dataItems will contain an the object's properties as they are exposed in a for..each loop.
| registerOwner | () | method |
public function registerOwner(dataCanvas:DataCanvas):voidRegisters a DisplayObject as the owner of this layout. Throws an error if the layout already has an owner.
Parameters
dataCanvas:DataCanvas |
| render | () | method |
public function render(newSprite:AxiisSprite = null):voidDraws this layout to the specified AxiisSprite.
If no sprite is provided this layout will use the last AxiisSprite it rendered to, if such an AxiisSprite exists. Otherwise this returns immediately.
This method is meant to be overridden by a subclass.
Parameters
newSprite:AxiisSprite (default = null) |
| itemDataTip | Event |
flash.events.EventDispatched when an AxiisSprite is mousedOver.