| Package | org.axiis.core |
| Class | public class BaseLayout |
| Inheritance | BaseLayout  AbstractLayout flash.events.EventDispatcher |
| Subclasses | AxisBase, ConcentricWedgeLayout, GroupingBase, HBoxLayout, HCategoryAxis, RepeaterLayout, VBoxLayout |
| Property | Defined By | ||
|---|---|---|---|
 | bounds : Rectangle
A rectangle that acts as the bounding area for this layout
| AbstractLayout | |
| buttonMode : Boolean = false
The value of the buttonMode flag to set for each child Sprite
| BaseLayout | ||
| 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 | |
| inheritParentBounds : Boolean = true
Whether or not the drawingGeometries should should have their initial
bounds set to the currentReference of the parent layout. | BaseLayout | ||
| 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 | |
| scaleFill : Boolean
Whether or not the fills in this geometry should be scaled within the
bounds rectangle. | BaseLayout | ||
| 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 | |
| useHandCursor : Boolean = false
The value of the useHandCursor flag to set each child Sprite
| BaseLayout | ||
| 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 | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | BaseLayout | ||
| 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, tracking all changes
made by data binding or the referenceRepeater. | BaseLayout | ||
| Method | Defined By | ||
|---|---|---|---|
| deselectChildren():void
Marks all children as deselected. | AbstractLayout | |
postIteration():void
The callback method called by the referenceRepeater after it applies
the PropertyModifiers on each iteration. | BaseLayout | ||
preIteration():void
The callback method called by the referenceRepeater before it applies
the PropertyModifiers on each iteration. | BaseLayout | ||
renderChildLayouts(child:AxiisSprite):void
Calls the render method on all child layouts. | BaseLayout | ||
repeatComplete():void
The callback method called by the referenceRepeater after it finishes
its final iteration. | BaseLayout | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when invalidate is called so the DataCanvas that owns this layout can being the process of redrawing the layout. | BaseLayout | |||
| Dispatched when an AxiisSprite is clicked. | BaseLayout | |||
| Dispatched when an AxiisSprite is mousedOver. | BaseLayout | |||
| Dispatched when an AxiisSprite is double clicked. | BaseLayout | |||
| Dispatched when an AxiisSprite is mousedOver. | BaseLayout | |||
| Dispatched when an AxiisSprite is mousedOut. | BaseLayout | |||
| Dispatched when an AxiisSprite is mousedOver. | BaseLayout | |||
| Dispatched before each individual child is rendered. | BaseLayout | |||
| Dispatched when an AxiisSprite is selected | BaseLayout | |||
| Dispatched when an AxiisSprite is unselected | BaseLayout | |||
| Dispatched at the beginning of the render method. | BaseLayout | |||
| Dispatched when layout has completed its render cycle | BaseLayout | |||
| buttonMode | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var buttonMode:Boolean = falseThe value of the buttonMode flag to set for each child Sprite
| inheritParentBounds | property |
public var inheritParentBounds:Boolean = trueWhether or not the drawingGeometries should should have their initial bounds set to the currentReference of the parent layout.
| scaleFill | property |
scaleFill:Boolean [read-write] Whether or not the fills in this geometry should be scaled within the bounds rectangle.
This property can be used as the source for data binding.
public function get scaleFill():Boolean public function set scaleFill(value:Boolean):void| useHandCursor | property |
public var useHandCursor:Boolean = falseThe value of the useHandCursor flag to set each child Sprite
| BaseLayout | () | Constructor |
public function BaseLayout()Constructor.
| postIteration | () | method |
protected function postIteration():voidThe callback method called by the referenceRepeater after it applies the PropertyModifiers on each iteration. This method updates the currentReference property and creates or updates the AxiisSprite that renders the currentDatum. It is recommended that subclasses override this method to perform any computations that affect the drawingGeometries that are based on the drawingGeometries themselves.
| preIteration | () | method |
protected function preIteration():voidThe callback method called by the referenceRepeater before it applies the PropertyModifiers on each iteration. This method updates the currentIndex, currentDatum, currentValue, and currentLabel properties. It is recommended that subclasses override this method to perform any custom data-driven computations that affect the drawingGeometries.
| render | () | method |
override public function render(newSprite:AxiisSprite = null):voidDraws this layout to the specified AxiisSprite, tracking all changes made by data binding or the referenceRepeater.
If no sprite is provided this layout will use the last AxiisSprite it rendered to, if such an AxiisSprite exists. Otherwise this returns immediately.
The render cycle occurs in several stages. By watching for these events or by binding onto the currentReference, currentIndex, or the currentDatum properties, you can inject your own logic into the render cycle. For example, if you bind a drawingGeometry's x position to currentReference.x and use a GeometryRepeater that adds 5 to the x property of the reference, the layout will render one geometry for each item in the dataProvider at every 5 pixels.
Parameters
newSprite:AxiisSprite (default = null) |
| renderChildLayouts | () | method |
protected function renderChildLayouts(child:AxiisSprite):voidCalls the render method on all child layouts.
Parameters
child:AxiisSprite |
| repeatComplete | () | method |
protected function repeatComplete():voidThe callback method called by the referenceRepeater after it finishes its final iteration. Stop tracking changes to the drawingGeometries properties.
| invalidateLayout | Event |
flash.events.EventDispatched when invalidate is called so the DataCanvas that owns this layout can being the process of redrawing the layout.
| itemClick | Event |
| itemDataTip | Event |
| itemDoubleClick | Event |
org.axiis.events.LayoutItemEventDispatched when an AxiisSprite is double clicked.
| itemMouseMove | Event |
| itemMouseOut | Event |
| itemMouseOver | Event |
| itemPreDraw | Event |
flash.events.EventDispatched before each individual child is rendered.
| itemSelected | Event |
| itemUnSelected | Event |
| preRender | Event |
flash.events.EventDispatched at the beginning of the render method. This event allowing listening objects the chance to perform any computations that will affect the layout's render process.
| renderComplete | Event |
flash.events.EventDispatched when layout has completed its render cycle