| Package | org.openPyro.controls |
| Class | public class List |
| Inheritance | List  UIContainer UIControl MeasurableControl flash.display.Sprite |
| Subclasses | Tree |
| Property | Defined by | ||
|---|---|---|---|
| autoResetScrollOnDataProviderChange : Boolean = true
Resets scrolls when the dataProvider changes
| List | ||
 | backgroundPainter : IPainter
UIControls can have a backgroundPainter object attached that is
triggered everytime updateDisplayList is called.
| UIControl | |
| clipContent : Boolean | UIContainer | |
| contentHeight : Number | UIContainer | |
| contentWidth : Number | UIContainer | |
| creationCompleteFired : Boolean | MeasurableControl | |
| dataProvider : Object | List | ||
| displayListInvalidated : Boolean = true
Flag to mark a dirty displaylist.
| MeasurableControl | |
| dragData : Object | UIControl | |
| dragEnabled : Boolean | UIControl | |
| dropEnabled : Boolean | UIControl | |
| explicitlyAllocatedHeight : Number
This property are modified by IContainerMeasurementHelpers.
| UIContainer | |
| explicitlyAllocatedWidth : Number
This property are modified by IContainerMeasurementHelpers.
| UIContainer | |
| explicitWidth : Number The height set in terms of actual pixels.
| MeasurableControl | |
| forceInvalidateDisplayList : Boolean = false | MeasurableControl | |
| height : Number
Set/get the height of the control.
| MeasurableControl | |
| horizontalScrollBar : ScrollBar
Returns The instance of the created horizontal
or null if it was never created or is not visible.
| UIContainer | |
| horizontalScrollIncrement : Number | UIContainer | |
| horizontalScrollPolicy : Boolean | UIContainer | |
| horizontalScrollPosition : Number | UIContainer | |
| includeInLayout : Boolean
Specifies whether this control participates in the
layout system in OpenPyro.
| MeasurableControl | |
| initialized : Boolean = false
Property indicates whether a control has been initialized
or not.
| MeasurableControl | |
| itemRenderer : ClassFactory
[write-only]
| List | ||
| labelFunction : Function | List | ||
| layout : ILayout
Containers can be assigned different layouts
which control the positioning of the
different controls.
| UIContainer | |
| layoutChildren : Array [read-only]
| List | ||
| maximumHeight : Number | MeasurableControl | |
| maximumWidth : Number | MeasurableControl | |
| measuredHeight : Number
Overrides the set measuredHeight property from
MeasurableControl to invalidate children
(UIControl acknowledges that it can have children whose
dimensions are based on its own)
| UIControl | |
| measuredWidth : Number
Overrides the set measuredWidth property from
MeasurableControl to invalidate children
(UIControl acknowledges that it can have children whose
dimensions are based on its own)
| UIControl | |
| mouseActionsDisabled : Boolean | MeasurableControl | |
| mouseOverDisabled : Boolean = false [static]
| UIContainer | |
| needsMeasurement : Boolean = true
Only setting percent width/heights changes the
needsMeasurement flag which makes its parent
container call measure on it.
| MeasurableControl | |
| originalRawDataProvider : Object [read-only]
| List | ||
| padding : Padding
Paddings define the unusable space within
UIContainers that should not be used for
measurement and layout.
| UIControl | |
| parentContainer : UIControl | MeasurableControl | |
| percentHeight : Number | MeasurableControl | |
| percentUnusedHeight : Number
Set/get the percent height.
| MeasurableControl | |
| percentUnusedWidth : Number
Set/get the percent width.
| MeasurableControl | |
| percentWidth : Number | MeasurableControl | |
| scrollHeight : Number
scrollHeight is the max height a vertical
scrollbar needs to scroll
| UIContainer | |
| scrollWidth : Number
scrollWidth is the max width a horizontal
scrollbar needs to scroll
| UIContainer | |
| selectedIndex : int | List | ||
| selectedItem : Object | List | ||
| sizeInvalidated : Boolean = false
The flag to mark that the control's size
has been invalidated.
| MeasurableControl | |
| skin : ISkin | UIControl | |
| skinnedControl : UIControl | UIControl | |
| styleName : String
Defines the skin this component is registered to.
| UIControl | |
| toolTip : * | UIControl | |
| usesMeasurementStrategy : Boolean
This property defines whether measure() will be called during
validateSize() or not.
| MeasurableControl | |
| verticalScrollBar : ScrollBar
Returns The instance of the created verticalScrollBar
or null if it was never created or is not visible.
| UIContainer | |
| verticalScrollIncrement : Number | UIContainer | |
| verticalScrollPolicy : Boolean | UIContainer | |
| verticalScrollPosition : Number | UIContainer | |
| visible : Boolean | MeasurableControl | |
| width : Number
Set/get the width of the control.
| MeasurableControl | |
| Method | Defined by | ||
|---|---|---|---|
|
List()
| List | ||
|
addChild(child:DisplayObject):DisplayObject
| UIContainer | |
|
addChildAt(child:DisplayObject, index:int):DisplayObject
| UIContainer | |
|
cancelMouseEvents():void
| MeasurableControl | |
|
checkDisplayListValidation():void
Calls the queueValidateDisplayList if measure causes
_dimensionsChanged to change to true.
| UIControl | |
|
dataToItemRenderer(data:*):DisplayObject
| List | ||
|
dataToItemRendererIndex(data:*):int
| List | ||
|
dispose():void
| UIControl | |
|
doLayoutChildren():void
Lays out the layoutChildren based
ILayout
object. | UIContainer | |
|
doOnAdded():void
[Temp] This function is called automatically
by a parent UIControl if this is created as a
child of a UIControl.
| MeasurableControl | |
|
enableMouseEvents():void
| MeasurableControl | |
|
getChildByName(name:String):DisplayObject
| UIContainer | |
|
getExplicitOrMeasuredHeight():Number
Returns the explicitly defined height or the measured
height computed by the
measure function. | MeasurableControl | |
|
getExplicitOrMeasuredWidth():Number
Returns the explicitly defined width or the measured
number computed by the
measure function. | MeasurableControl | |
|
heightForMeasurement():Number
When measure is called, it uses the widthForMeasurement and
heightForMeasurement to calculate the sizes for
percent-dimension based children
| UIContainer | |
|
initialize():void
This happens only once when a child is
first added to any parent.
| UIContainer | |
|
invalidateSize(event:PyroEvent = null):void
Marks itself dirty and waits till either the container
to validateSize or validates itself at the next enterframe
if it has no parent container.
| MeasurableControl | |
|
isMouseOver(event:MouseEvent):Boolean
Utility function to check if a mouseEvent happened
while the mouse was over the displayObject
| MeasurableControl | |
|
itemRendererToIndex(renderer:DisplayObject):int
| List | ||
|
measure():void
Measure is called during the validateSize if
the needsmeasurement flag is set.
| UIControl | |
| UIControl | ||
|
queueValidateDisplayList(event:PyroEvent = null):void
This function is called if the framework determines that dimensions of the
control have changed.
| MeasurableControl | |
|
removeAllChildren():void
| UIContainer | |
|
removeBackgroundPainter():void
| UIControl | |
|
removeChild(child:DisplayObject):DisplayObject
| UIContainer | |
|
resizeHandler():void
| MeasurableControl | |
|
Convinience function for setting width and height
in one call.
| UIControl | |
|
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
| List | ||
|
validateDisplayList(event:Event = null):void
validateDisplayList is called as a response to invalidateDisplayList.
| MeasurableControl | |
|
validateSize():void
The validateSize function is called in response to
a component declaring its size invalid (usually
by calling invalidateSize()).
| UIContainer | |
|
widthForMeasurement():Number
When measure is called, it uses the widthForMeasurement and
heightForMeasurement to calculate the sizes for
percent-dimension based children
| UIContainer | |
| Method | Defined by | ||
|---|---|---|---|
|
calculateMeasuredHeight():void
Calculates the measuredHeight property.
| MeasurableControl | |
|
calculateMeasuredWidth():void
Calculates the measuredWidth property.
| MeasurableControl | |
|
checkNeedsHScrollBar():void
| UIContainer | |
|
checkNeedsVScrollBar():void
| UIContainer | |
|
checkRevalidation():void
| UIContainer | |
|
convertDataToCollection(dp:Object):void
Converts an Array to ArrayCollection or xml to
XMLCollection.
| List | ||
|
createChildren():void
| List | ||
|
createHScrollBar():void
| UIContainer | |
|
createRenderers():void
| List | ||
|
createVScrollBar():void
| UIContainer | |
|
destroyOldRenderers():void
| List | ||
|
disableEvent(event:Event):void
| MeasurableControl | |
|
dispatchDragStart(event:MouseEvent):void
| UIControl | |
|
dispatchUpdateComplete():void
Dispatches the UpdateComplete event
| MeasurableControl | |
|
doChildBasedValidation():void
| UIContainer | |
|
doQueuedValidateSize(event:Event):void
doQueueValidateSize is executed by the top level UIControl.
| MeasurableControl | |
|
handDataProviderItemsAdded(event:CollectionEvent):void
| List | ||
|
handleDataProviderItemsRemoved(event:CollectionEvent):void
| List | ||
|
handleMouseWheel(event:MouseEvent):void
| UIContainer | |
|
handlePreDragMouseDown(event:Event):void
This function is called if the UIControl instance is drag enabled
and the user clicks the mouse down.
| UIControl | |
|
handleRendererClick(event:MouseEvent):void
| List | ||
|
hideHScrollBar():void
| UIContainer | |
|
hideVScrollBar():void
| UIContainer | |
|
invalidateDisplayList():void
| MeasurableControl | |
|
onAddedToParent(event:Event):void
The event listener executed when this component
has been added to the parent.
| MeasurableControl | |
|
onHorizontalScroll(event:ScrollEvent):void
Event listener for when the horizontal scrollbar is
used.
| UIContainer | |
|
onHorizontalScrollBarSizeValidated(event:PyroEvent):void
| UIContainer | |
|
onHScrollBarUpdateComplete(event:PyroEvent):void
Event listener for the horizontal scrollbar's
creation and validation event.
| UIContainer | |
|
onSkinnedControlResize(event:Event):void
Event handler for when the UIControl is applied as a Skin
and the control it is skinning is resized.
| UIControl | |
|
onVerticalScroll(event:ScrollEvent):void
Event listener for when the vertical scrollbar is
used.
| UIContainer | |
|
onVerticalScrollBarSizeValidated(event:PyroEvent):void
| UIContainer | |
|
onVScrollBarUpdateComplete(event:PyroEvent):void
Event listener for the vertical scrollbar's
creation and validation event.
| UIContainer | |
|
returnRenderersToPool():void
| List | ||
|
setContentMask():void
| UIContainer | |
|
setRendererData(renderer:DisplayObject, data:Object, index:int):void
| List | ||
|
setVerticalScrollBar():void
| UIContainer | |
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| List | ||||
| UIControl | |||
| MeasurableControl | |||
| List | ||||
| MeasurableControl | |||
| MeasurableControl | |||
| MeasurableControl | |||
| MeasurableControl | |||
| MeasurableControl | |||
| MeasurableControl | |||
| MeasurableControl | |||
| autoResetScrollOnDataProviderChange | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var autoResetScrollOnDataProviderChange:Boolean = trueResets scrolls when the dataProvider changes
| _dataProvider | property |
protected var _dataProvider:ICollection
| dataProvider | property |
dataProvider:Object [read-write]Implementation
public function get dataProvider():Object
public function set dataProvider(value:Object):void
| itemRenderer | property |
itemRenderer:ClassFactory [write-only]Implementation
public function set itemRenderer(value:ClassFactory):void
| _labelFunction | property |
protected var _labelFunction:Function
| labelFunction | property |
labelFunction:Function [read-write]Implementation
public function get labelFunction():Function
public function set labelFunction(value:Function):void
| layoutChildren | property |
layoutChildren:Array [read-only]Implementation
public function get layoutChildren():Array
| _originalRawDataProvider | property |
protected var _originalRawDataProvider:Object
| originalRawDataProvider | property |
originalRawDataProvider:Object [read-only]Implementation
public function get originalRawDataProvider():Object
| _rendererPool | property |
protected var _rendererPool:ObjectPool
| renderers | property |
protected var renderers:Array
| _selectedIndex | property |
protected var _selectedIndex:int = -1
| selectedIndex | property |
selectedIndex:int [read-write]Implementation
public function get selectedIndex():int
public function set selectedIndex(value:int):void
| _selectedItem | property |
protected var _selectedItem:Object
| selectedItem | property |
selectedItem:Object [read-write]Implementation
public function get selectedItem():Object
public function set selectedItem(value:Object):void
| selectedRenderer | property |
protected var selectedRenderer:DisplayObject
| List | () | constructor |
public function List()
| convertDataToCollection | () | method |
protected function convertDataToCollection(dp:Object):voidConverts an Array to ArrayCollection or xml to XMLCollection. Written as a separate function so that overriding classes may massage the data as needed
Parametersdp:Object |
| createChildren | () | method |
protected override function createChildren():void
| createRenderers | () | method |
protected function createRenderers():void
| dataToItemRenderer | () | method |
public function dataToItemRenderer(data:*):DisplayObjectParameters
data:* |
DisplayObject |
| dataToItemRendererIndex | () | method |
public function dataToItemRendererIndex(data:*):intParameters
data:* |
int |
| destroyOldRenderers | () | method |
protected function destroyOldRenderers():void
| handDataProviderItemsAdded | () | method |
protected function handDataProviderItemsAdded(event:CollectionEvent):voidParameters
event:CollectionEvent |
| handleDataProviderItemsRemoved | () | method |
protected function handleDataProviderItemsRemoved(event:CollectionEvent):voidParameters
event:CollectionEvent |
| handleRendererClick | () | method |
protected function handleRendererClick(event:MouseEvent):voidParameters
event:MouseEvent |
| itemRendererToIndex | () | method |
public function itemRendererToIndex(renderer:DisplayObject):intParameters
renderer:DisplayObject |
int |
| returnRenderersToPool | () | method |
protected function returnRenderersToPool():void
| setRendererData | () | method |
protected function setRendererData(renderer:DisplayObject, data:Object, index:int):voidParameters
renderer:DisplayObject |
|
data:Object |
|
index:int |
| updateDisplayList | () | method |
public override function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):voidParameters
unscaledWidth:Number |
|
unscaledHeight:Number |
| change | event |
| itemClick | event |