| Package | org.openPyro.controls |
| Class | public class Image |
| Inheritance | Image  UIControl MeasurableControl flash.display.Sprite |
| Property | Defined by | ||
|---|---|---|---|
| autoLoad : Boolean | Image | ||
 | backgroundPainter : IPainter
UIControls can have a backgroundPainter object attached that is
triggered everytime updateDisplayList is called.
| UIControl | |
| contentHeight : Number [read-only]
| Image | ||
| contentWidth : Number [read-only]
| Image | ||
| creationCompleteFired : Boolean | MeasurableControl | |
| displayListInvalidated : Boolean = true
Flag to mark a dirty displaylist.
| MeasurableControl | |
| 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 | |
| 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 | |
| loader : Loader [read-only]
Returns the raw loader being used to load the image
| Image | ||
| loaderContext : LoaderContext
The LoaderContext that is used when loading an
image.
| Image | ||
| maintainAspectRatio : Boolean | Image | ||
| 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 | |
| originalContentHeight : Number [read-only]
| Image | ||
| originalContentWidth : Number [read-only]
| Image | ||
| 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 | |
| scaleToFit : Boolean | Image | ||
| sizeInvalidated : Boolean = false
The flag to mark that the control's size
has been invalidated.
| MeasurableControl | |
| skin : ISkin | UIControl | |
| skinnedControl : UIControl | UIControl | |
| source : String [write-only]
| Image | ||
| 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 | |
| visible : Boolean | MeasurableControl | |
| width : Number
Set/get the width of the control.
| MeasurableControl | |
| Method | Defined by | ||
|---|---|---|---|
|
Image()
| Image | ||
|
addChild(child:DisplayObject):DisplayObject
| UIControl | |
|
addChildAt(child:DisplayObject, index:int):DisplayObject
| UIControl | |
|
cancelMouseEvents():void
| MeasurableControl | |
|
checkDisplayListValidation():void
Calls the queueValidateDisplayList if measure causes
_dimensionsChanged to change to true.
| UIControl | |
|
dispose():void
| UIControl | |
|
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 | |
|
isContentLoaded():Boolean
Flag to check if the remote content is loaded
or not.
| Image | ||
|
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 | |
|
Convinience function for setting width and height
in one call.
| UIControl | |
|
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
| Image | ||
|
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
| Image | ||
|
disableEvent(event:Event):void
| MeasurableControl | |
|
dispatchDragStart(event:MouseEvent):void
| UIControl | |
|
dispatchUpdateComplete():void
Dispatches the UpdateComplete event
| MeasurableControl | |
|
doChildBasedValidation():void
| Image | ||
|
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 | |
|
onIOError(event:IOErrorEvent):void
| Image | ||
|
onLoadComplete(event:Event):void
| Image | ||
|
onSkinnedControlResize(event:Event):void
Event handler for when the UIControl is applied as a Skin
and the control it is skinning is resized.
| UIControl | |
|
scaleImageContent():void
| Image | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| Complete event is dispatched when the image load is completed. | Image | |||
| UIControl | |||
| MeasurableControl | |||
| MeasurableControl | |||
| MeasurableControl | |||
| MeasurableControl | |||
| MeasurableControl | |||
| MeasurableControl | |||
| MeasurableControl | |||
| MeasurableControl | |||
| _autoLoad | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var _autoLoad:Boolean = true
| autoLoad | property |
autoLoad:Boolean [read-write]Implementation
public function get autoLoad():Boolean
public function set autoLoad(value:Boolean):void
| contentHeight | property |
contentHeight:Number [read-only]Implementation
public function get contentHeight():Number
| contentWidth | property |
contentWidth:Number [read-only]Implementation
public function get contentWidth():Number
| _isContentLoaded | property |
protected var _isContentLoaded:Boolean = false
| loader | property |
loader:Loader [read-only]Returns the raw loader being used to load the image
Implementation public function get loader():Loader
| loaderContext | property |
loaderContext:LoaderContext [read-write]The LoaderContext that is used when loading an image.
Implementation public function get loaderContext():LoaderContext
public function set loaderContext(value:LoaderContext):void
| _maintainAspectRatio | property |
protected var _maintainAspectRatio:Boolean = true
| maintainAspectRatio | property |
maintainAspectRatio:Boolean [read-write]Implementation
public function get maintainAspectRatio():Boolean
public function set maintainAspectRatio(value:Boolean):void
| _originalContentHeight | property |
protected var _originalContentHeight:Number = NaN
| originalContentHeight | property |
originalContentHeight:Number [read-only]Implementation
public function get originalContentHeight():Number
| _originalContentWidth | property |
protected var _originalContentWidth:Number = NaN
| originalContentWidth | property |
originalContentWidth:Number [read-only]Implementation
public function get originalContentWidth():Number
| _scaleToFit | property |
protected var _scaleToFit:Boolean = true
| scaleToFit | property |
scaleToFit:Boolean [read-write]Implementation
public function get scaleToFit():Boolean
public function set scaleToFit(value:Boolean):void
| source | property |
source:String [write-only]Implementation
public function set source(value:String):void
| Image | () | constructor |
public function Image()
| createChildren | () | method |
protected override function createChildren():void
| doChildBasedValidation | () | method |
protected override function doChildBasedValidation():void
| isContentLoaded | () | method |
public function isContentLoaded():BooleanFlag to check if the remote content is loaded or not.
ReturnsBoolean |
| onIOError | () | method |
protected function onIOError(event:IOErrorEvent):voidParameters
event:IOErrorEvent |
| onLoadComplete | () | method |
protected function onLoadComplete(event:Event):voidParameters
event:Event |
| scaleImageContent | () | method |
protected function scaleImageContent():void
| updateDisplayList | () | method |
public override function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):voidParameters
unscaledWidth:Number |
|
unscaledHeight:Number |
| complete | event |
flash.events.Event
Complete event is dispatched when the image load is completed.