| Package | org.openPyro.aurora |
| Class | public class AuroraPainterButtonSkin |
| Inheritance | AuroraPainterButtonSkin  UIControl MeasurableControl flash.display.Sprite |
| Implements | IStateFulClient |
| Subclasses | AuroraCheckBoxSkin |
| Property | Defined by | ||
|---|---|---|---|
 | backgroundPainter : IPainter
UIControls can have a backgroundPainter object attached that is
triggered everytime updateDisplayList is called.
| UIControl | |
| creationCompleteFired : Boolean | MeasurableControl | |
| displayListInvalidated : Boolean = true
Flag to mark a dirty displaylist.
| MeasurableControl | |
| downPainter : IPainter | AuroraPainterButtonSkin | ||
| dragData : Object | UIControl | |
| dragEnabled : Boolean | UIControl | |
| dropEnabled : Boolean | UIControl | |
| 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 | |
| icon : DisplayObject [write-only]
| AuroraPainterButtonSkin | ||
| 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 | |
| labelAlign : String [write-only]
| AuroraPainterButtonSkin | ||
| labelFormat : TextFormat | AuroraPainterButtonSkin | ||
| 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 | |
| needsMeasurement : Boolean = true
Only setting percent width/heights changes the
needsMeasurement flag which makes its parent
container call measure on it.
| MeasurableControl | |
| overPainter : IPainter | AuroraPainterButtonSkin | ||
| padding : Padding
Paddings define the unusable space within
UIContainers that should not be used for
measurement and layout.
| UIControl | |
| painters : IPainter
[write-only]
| AuroraPainterButtonSkin | ||
| 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 | |
| sizeInvalidated : Boolean = false
The flag to mark that the control's size
has been invalidated.
| MeasurableControl | |
| skin : ISkin | UIControl | |
| skinnedControl : UIControl
[write-only]
| AuroraPainterButtonSkin | ||
| styleName : String
Defines the skin this component is registered to.
| UIControl | |
| toolTip : * | UIControl | |
| upPainter : IPainter | AuroraPainterButtonSkin | ||
| usesMeasurementStrategy : Boolean
This property defines whether measure() will be called during
validateSize() or not.
| MeasurableControl | |
| visible : Boolean | MeasurableControl | |
| width : Number
Set/get the width of the control.
| MeasurableControl | |
| Method | Defined by | ||
|---|---|---|---|
|
A skin for buttons using different painters.
| AuroraPainterButtonSkin | ||
|
addChild(child:DisplayObject):DisplayObject
| UIControl | |
|
addChildAt(child:DisplayObject, index:int):DisplayObject
| UIControl | |
|
cancelMouseEvents():void
| MeasurableControl | |
|
changeState(fromState:String, toState:String):void
| AuroraPainterButtonSkin | ||
|
checkDisplayListValidation():void
Calls the queueValidateDisplayList if measure causes
_dimensionsChanged to change to true.
| UIControl | |
|
dispose():void
| AuroraPainterButtonSkin | ||
|
doLayoutChildren():void
| UIControl | |
|
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 | |
|
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
| UIControl | |
|
initialize():void
This happens only once when a child is
first added to any parent.
| UIControl | |
|
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 | |
|
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 | |
|
removeBackgroundPainter():void
| UIControl | |
|
removeChild(d:DisplayObject):DisplayObject
| UIControl | |
|
resizeHandler():void
| MeasurableControl | |
|
setPainters(upPainter:IPainter, overPainter:IPainter = null, downPainter:IPainter = null):AuroraPainterButtonSkin
| AuroraPainterButtonSkin | ||
|
Convinience function for setting width and height
in one call.
| UIControl | |
|
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
| AuroraPainterButtonSkin | ||
|
updateLabel():void
| AuroraPainterButtonSkin | ||
|
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()).
| MeasurableControl | |
|
widthForMeasurement():Number
When measure is called, it uses the widthForMeasurement and
heightForMeasurement to calculate the sizes for
percent-dimension based children
| UIControl | |
| Method | Defined by | ||
|---|---|---|---|
|
calculateMeasuredHeight():void
Calculates the measuredHeight property.
| MeasurableControl | |
|
calculateMeasuredWidth():void
Calculates the measuredWidth property.
| MeasurableControl | |
|
createChildren():void
This is where the new children should
be created and then added to the displaylist.
| MeasurableControl | |
|
disableEvent(event:Event):void
| MeasurableControl | |
|
dispatchDragStart(event:MouseEvent):void
| UIControl | |
|
dispatchUpdateComplete():void
Dispatches the UpdateComplete event
| MeasurableControl | |
|
doChildBasedValidation():void
While UIControls can be sized based on the dimensions of the parent
container, if the explicit or percent dimension values are not specified,
the UIControl can look at its children's dimensions and base its
sizing off them.
| UIControl | |
|
doQueuedValidateSize(event:Event):void
doQueueValidateSize is executed by the top level UIControl.
| MeasurableControl | |
|
handlePreDragMouseDown(event:Event):void
This function is called if the UIControl instance is drag enabled
and the user clicks the mouse down.
| UIControl | |
|
invalidateDisplayList():void
| MeasurableControl | |
|
onAddedToParent(event:Event):void
The event listener executed when this component
has been added to the parent.
| MeasurableControl | |
|
onSkinnedControlPropertyChange(event:PyroEvent):void
| AuroraPainterButtonSkin | ||
|
onSkinnedControlResize(event:Event):void
Event handler for when the UIControl is applied as a Skin
and the control it is skinning is resized.
| UIControl | |
| downPainter | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var downPainter:IPainter
| _icon | property |
protected var _icon:DisplayObject
| icon | property |
icon:DisplayObject [write-only]Implementation
public function set icon(value:DisplayObject):void
| label | property |
protected var label:Label
| labelAlign | property |
labelAlign:String [write-only]Implementation
public function set labelAlign(value:String):void
| _labelFormat | property |
protected var _labelFormat:TextFormat
| labelFormat | property |
labelFormat:TextFormat [read-write]Implementation
public function get labelFormat():TextFormat
public function set labelFormat(value:TextFormat):void
| overPainter | property |
public var overPainter:IPainter
| painters | property |
| skinnedControl | property |
skinnedControl:UIControl [write-only]Implementation
public function set skinnedControl(value:UIControl):void
| upPainter | property |
public var upPainter:IPainter
| AuroraPainterButtonSkin | () | constructor |
public function AuroraPainterButtonSkin()A skin for buttons using different painters. Note: Only padding left and padding top are respected if align is set to left
| changeState | () | method |
public function changeState(fromState:String, toState:String):voidParameters
fromState:String |
|
toState:String |
| dispose | () | method |
public override function dispose():void
| onSkinnedControlPropertyChange | () | method |
| setPainters | () | method |
public function setPainters(upPainter:IPainter, overPainter:IPainter = null, downPainter:IPainter = null):AuroraPainterButtonSkinParameters
upPainter:IPainter |
|
overPainter:IPainter (default = null) |
|
downPainter:IPainter (default = null) |
AuroraPainterButtonSkin |
| updateDisplayList | () | method |
public override function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):voidParameters
unscaledWidth:Number |
|
unscaledHeight:Number |
| updateLabel | () | method |
public function updateLabel():void