Packageorg.aswing
Classpublic class AssetPane
InheritanceAssetPane Inheritance Container Inheritance Component Inheritance AWSprite Inheritance flash.display.Sprite
SubclassesJAttachPane, JLoadPane

Abstract class for A container with a decorative asset.

External content will be load automatically when the pane was created if floorEnabled.

See also

org.aswing.JLoadPane
org.aswing.JAttachPane


Public Properties
 PropertyDefined by
 InheritedcacheAsBitmap : Boolean
AWSprite
 Inheritedcontainer : Container
Component
 Inheritedfilters : Array
AWSprite
 Inheritedheight : Number
Component
 Inheritedmask : DisplayObject
AWSprite
 InheritednumChildren : int
AWSprite
 Inheritedvisible : Boolean
Component
 Inheritedwidth : Number
Component
 Inheritedx : Number
Component
 Inheritedy : Number
Component
Protected Properties
 PropertyDefined by
  asset : DisplayObject
AssetPane
  assetContainer : DisplayObjectContainer
AssetPane
  assetMask : Shape
AssetPane
 Inheritedbounds : IntRectangle
Component
 Inheritedchildren : Array
Container
 Inheritedd_numChildren : int
AWSprite
 InheriteddrawTransparentTrigger : Boolean = true
Component
 Inheritedd_visible : Boolean
Returns the DisplayObject.visible directly.
Component
 Inheritedd_x : Number
Returns DisplayObject.x directly.
Component
 Inheritedd_y : Number
Returns DisplayObject.y directly.
Component
 Inheritedlayout : LayoutManager
Container
 InheritedreadyToPaint : Boolean
Component
 Inheritedui : ComponentUI
Component
 Inheritedvalid : Boolean
Component
Public Methods
 MethodDefined by
  
AssetPane(asset:DisplayObject = null, prefferSizeStrategy:int)
AssetPane(path:String, prefferSizeStrategy:int)
AssetPane(path:String) prefferSizeStrategy default to PREFER_SIZE_BOTH
AssetPane() path default to null,prefferSizeStrategy default to PREFER_SIZE_IMAGE

Creates a AssetPane with a path to load external content.

AssetPane
 Inherited
addChild(dis:DisplayObject):DisplayObject
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
AWSprite
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
AWSprite
 Inherited
Adds a component to be the acceptable drag initiator to this component.
Component
 Inherited
append(com:Component, constraints:Object = null):void
On Component just can add to one Container.
Container
 Inherited
appendAll(... coms):void
Adds one or more component to the container with null constraints
Container
 Inherited
bringToBottom(child:DisplayObject):void
Brings a child to bottom.
AWSprite
 Inherited
bringToTop(child:DisplayObject):void
Brings a child to top.
AWSprite
 Inherited
Component
 Inherited
containsChild(child:DisplayObject):Boolean
Returns whether child is directly child of this sprite, true only if getChildIndex(child) >= 0.
AWSprite
  
doLayout():void
layout this container
AssetPane
 Inherited
fireFocusKeyDownEvent(e:KeyboardEvent):void
Component
 Inherited
fireFocusKeyUpEvent(e:KeyboardEvent):void
Component
  
Returns current actual scale value in percents.
AssetPane
 Inherited
getAlignmentX():Number
Returns the alignment along the x axis.
Component
 Inherited
getAlignmentY():Number
Returns the alignment along the y axis.
Component
 Inherited
getAlpha():Number
Returns the alpha of this component.
Component
  
getAsset():DisplayObject
Returns the asset of the pane.
AssetPane
  
Returns the asset's original size.
AssetPane
 Inherited
getAwmlID():String
Returns ID used to identify components created from AWML.
Component
 Inherited
getAwmlIndex():Number
Returns position index of the component inside its AWML container.
Component
 Inherited
Returns namespace name used to identify components created from AWML.
Component
 Inherited
Gets the background color of this component.
Component
 Inherited
Returns the background decorator of this component.
Component
 Inherited
Returns the border.
Component
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
Same to DisplayObject.getBounds(), just add a explaination here that if you want to get the component bounds, see {
Component
 Inherited
getChildAt(index:int):DisplayObject
AWSprite
 Inherited
getChildByName(name:String):DisplayObject
AWSprite
 Inherited
getChildIndex(child:DisplayObject):int
AWSprite
 Inherited
Returns the value of the property with the specified key.
Component
 Inherited
Returns the clip bounds.
Component
 Inherited

Stores the bounds value of this component into "return value" rv and returns rv.

Component
 Inherited
getComponent(index:int):Component
Gets the nth(index) component in this container.
Container
 Inherited
Gets the number of components in this container.
Container
 Inherited
getConstraints():Object
Gets cpmponent's constraints.
Component
  
Returns current custom scale value in percents.
AssetPane
 Inherited
Returns the default basic ui class for this component.
Component
 Inherited
Returns the focus manager for this component's stage, or null if this component is not on stage.
Component
 Inherited
Returns the focus traversal policy of this container, it will return its parent's focus traversal policy if its self is null.
Container
 Inherited
Gets the font of this component.
Component
 Inherited
Gets the foreground color of this component.
Component
 Inherited
Returns the foreground decorator of this component.
Component
 Inherited
Stores the global location value of this component into "return value" p and returns p.
Component
 Inherited
getHeight():int
Returns the current height of this component
Component
 Inherited
Returns the current top index for a new child(none forground child).
AWSprite
  
Returns the horizontal alignment of the image/animation.
AssetPane
 Inherited
Returns the index of the child component in this container.
Container
 Inherited
If a border has been set on this component, returns the border's insets; otherwise returns an empty insets.
Component
 Inherited
getInternalFocusObject():InteractiveObject
Returns the object to receive the focus for this component.
Component
 Inherited
Returns the keyboard manager of this component's JRootPane ancestor.
Component
 Inherited
Container
 Inherited
Stores the location value of this component into "return value" rv and returns rv.
Component
 Inherited
Returns the current bottom index for none background child.
AWSprite
 Inherited
Returns getMaximumSize().height
Component
 Inherited
Component
 Inherited
Returns getMaximumSize().width
Component
 Inherited
Returns getMinimumSize().height
Component
 Inherited
Component
 Inherited
Returns getMinimumSize().width
Component
 Inherited
Returns the coordinate of the mouse position, in pixels, in the component scope.
Component
 Inherited
getName():String
Returns the name of the component
Component
  
getOffsetX():Number
AssetPane
  
getOffsetY():Number
AssetPane
 Inherited
Returns the bounds that component should paint in.
Component
 Inherited
Returns the Container parent, if it parent is not a Container, null will be returned.
Component
 Inherited
Returns getPreferredSize().height
Component
 Inherited
Component
 Inherited
Returns getPreferredSize().width
Component
  
Returns the preffered size counting strategy.
AssetPane
 Inherited
Returns the first JRootPane ancestor of this component.
Component
  
Returns current image scale mode.
AssetPane
 Inherited
Stores the size value of this component into "return value" rv and returns rv.
Component
 Inherited
getToolTipText():String
Returns the tooltip string that has been set with setToolTipText.
Component
 Inherited
Component
 Inherited
getUIClassID():String
Returns the UIDefaults key used to look up the name of the org.aswing.plaf.ComponentUI class that defines the look and feel for this component.
Component
  
Returns the vertical alignment of the image/animation.
AssetPane
 Inherited
getWidth():int
Returns the current width of this component
Component
 Inherited
getX():int
Returns the current x coordinate of the components.
Component
 Inherited
getY():int
Returns the current y coordinate of the components.
Component
 Inherited
Component
 Inherited
hitTestMouse():Boolean
Returns whether the component hit the mouse.
Component
 Inherited
hitTestObject(obj:DisplayObject):Boolean
AWSprite
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
AWSprite
 Inherited
insert(i:int, com:Component, constraints:Object = null):void
Add component to spesified index.
Container
 Inherited
insertAll(index:int, ... coms):void
Insets one or more component to the container with null constraints at specified starting index.
Container
 Inherited
invalidate():void
Invalidates the container.
Container
 Inherited
Clears this component and all parents above it's preferred size caches.
Component
 Inherited
Checks if the component is contained in the component hierarchy of this container.
Container
  
isAssetVisible():Boolean
Returns the asset visible property.
AssetPane
 Inherited
Returns whether or not the preferred size, minimum size and max size cache is turned on.
Component
 Inherited
isClipMasked():Boolean
Returns whether the component clip should be masked by its bounds.
AWSprite
 Inherited
Returns whether the component is acceptable drag initiator for this component.
Component
 Inherited
isDragEnabled():Boolean
Returns whether this component can fire ON_DRAG_RECOGNIZED event.
Component
 Inherited
isDropTrigger():Boolean
Returns whether this component can trigger dragging component to fire drag events when dragging over to this component.(Default value is false)
Component
 Inherited
isEnabled():Boolean
Returns whether the component is enabled.
Component
 Inherited
isFocusable():Boolean
Returns whether this Component can be focused.
Component
 Inherited
isFocusableSet():Boolean
Returns whether or not the opaque property is set by user.
Component
 Inherited
isFocusOwner():Boolean
Returns true if this Component is the focus owner.
Component
 Inherited
isFontValidated():Boolean
Returns whether the new font are applied and taked effect.
Component
  
isLoaded():Boolean
Returns is the asset was loaded ok.
AssetPane
  
isMaskAsset():Boolean
AssetPane
 Inherited
isOnStage():Boolean
Determines whether or not this component is on stage(on the display list).
Component
 Inherited
isOpaque():Boolean
Returns true if this component is completely opaque.
Component
 Inherited
isOpaqueSet():Boolean
Returns whether or not the opaque property is set by user.
Component
 Inherited
isShowing():Boolean
Determines whether this component is showing on screen.
Component
 Inherited
isUIElement():Boolean
Returns true if this component is just a ui element component, false means this component is a regular use created component.
Component
 Inherited
isValid():Boolean
Determines whether this component is valid.
Component
 Inherited
isValidateRoot():Boolean
If this method returns true, revalidate calls by descendants of this component will cause the entire tree beginning with this root to be validated.
Component
 Inherited
isVisible():Boolean
Component
 Inherited
makeFocus():void
Makes this component's internal focus object to be the stage focus directly, without any judgement.
Component
 Inherited
pack():void
Causes this component to be sized to fit the preferred size.
Component
 Inherited
paintFocusRect(force:Boolean = false):void
Paints the focus rect if need.
Component
 Inherited
Redraw the component UI face immediately if it is visible and ready to paint.
Component
 Inherited
Calls parent reAppendChildren if parent is a container.
Component
 Inherited
putClientProperty(key:*, value:*):void
Adds an arbitrary key/value "client property" to this component.
Component
 Inherited
Removes all children and then append them with their constraints.
Container
 Inherited
reAppendToParent(constraints:Object = null):void
Removes this component from its parent and then append it with specified constraints.
Component
  
reload():void
Reload the asset.
AssetPane
 Inherited
Remove the specified child component.
Container
 Inherited
removeAll():void
Remove all child components.
Container
 Inherited
Remove the specified index child component.
Container
 Inherited
removeChild(child:DisplayObject):DisplayObject
Removes a normal display object child.
Container
 Inherited
removeChildAt(index:int):DisplayObject
Removes a normal display object child with index.
Container
 Inherited
Removes a component to be the acceptable drag initiator to this component.
Component
 Inherited
Removes this component from its parent, whatever it is as a component child or only a display object child, or it's parent is just a display object container.
Component
 Inherited
repaint():void
Redraws the component face next RENDER event.This method can be called often, so it needs to execute quickly.
Component
 Inherited
Component
 Inherited
requestFocus():Boolean
Requests that this Component get the input focus, and that this Component's top-level ancestor become the focused Window.
Component
 Inherited
revalidate():void
Supports deferred automatic layout.
Component
 Inherited
Component
 Inherited
setAlignmentX(ax:Number):void
Component
 Inherited
setAlignmentY(ay:Number):void
Component
 Inherited
setAlpha(alpha:Number):void
Indicates the alpha transparency value of the component.
Component
  
setAsset(asset:DisplayObject):void
set the asset of the pane This method will cause old asset to be removed and new asset to be added.
AssetPane
  
setAssetVisible(b:Boolean):void
Sets the visible of the assets.
AssetPane
 Inherited
setAwmlID(id:String):void
Sets ID used to identify components created from AWML.
Component
 Inherited
setAwmlIndex(index:Number):void
Sets ID used to identify components created from AWML.
Component
 Inherited
setAwmlNamespace(theNamespace:String):void
Sets namespace used to identify components created from AWML.
Component
 Inherited
Sets the background color of this component.
Component
 Inherited
Sets a decorator to be the component background, it will represent the component background with a DisplayObject.
Component
 Inherited
setBorder(b:Border):void
Sets the border for the component, null to remove border.
Component
 Inherited
This method will call setComBounds()
Component
 Inherited
setCachePreferSizes(b:Boolean):void
Sets whether or not turn on the preferred size, minimum size and max size cache.
Component
 Inherited
setChildIndex(child:DisplayObject, index:int):void
AWSprite
 Inherited
Sets the clip bounds, a rectangle mask to make specified bounds visible.
Component
 Inherited
setClipMasked(m:Boolean):void
Sets whether the component clip should be masked by its bounds.
AWSprite
 Inherited
Sets the clip size, a rectangle mask to make specified bounds visible.
Component
 Inherited
Moves and resizes this component.
Component
 Inherited
setComBoundsXYWH(x:int, y:int, w:int, h:int):void
Moves and resizes this component.
Component
 Inherited
setConstraints(constraints:Object):void
Sets component's constraints.
Component
  
setCustomScale(scale:int):void
Sets new custom scale value in percents.
AssetPane
 Inherited
Sets a function to judge whether a component is acceptable drag initiator.
Component
 Inherited
setDragEnabled(b:Boolean):void
Sets whether this component can fire ON_DRAG_RECOGNIZED event.
Component
 Inherited
setDropTrigger(b:Boolean):void
Sets whether this component can trigger dragging component to fire drag events when dragging over to this component.
Component
 Inherited
setEnabled(b:Boolean):void
Enable or disable the component.
Component
 Inherited
setFocusable(b:Boolean):void
Sets the focusable state of this Component to the specified value.
Component
 Inherited
setFocusableSet(b:Boolean):void
Indicate that the focusable property is set by user or not.
Component
 Inherited
Sets the focus traversal policy to this container, or sets null to make this container use its parent's focus traversal policy.
Container
 Inherited
setFont(newFont:ASFont):void
Sets the text font for this component.
this method will cause a repaint and revalidate method call.
Component
 Inherited
setFontValidated(b:Boolean):void
Sets whether the new font are applied and taked effect.
Component
 Inherited
Sets the foreground color of this component.
Component
 Inherited
Sets a decorator to be the component foreground, it will represent the component foreground with a DisplayObject on top of other children of this component.
Component
 Inherited
Set the component's location in global coordinate.
Component
 Inherited
setGlobalLocationXY(x:int, y:int):void
Set the component's location in global coordinate.
Component
 Inherited
setHeight(height:Number):void
Sets the component's height.
Component
  
setHorizontalAlignment(alignment:int):void
Sets the horizontal alignment of the image/animation.
AssetPane
 Inherited
setLayout(layout:LayoutManager):void
Container
 Inherited
setLocation(newPos:IntPoint):void
Set the component's location, if it is diffs from old location, invalidate it to wait validate.
Component
 Inherited
setLocationXY(x:int, y:int):void
Component
  
setMaskAsset(m:Boolean):void
AssetPane
 Inherited
setMaximumHeight(maximumHeight:int):void
Sets maximum height, -1 means auto count.
Component
 Inherited
setMaximumSize(maximumSize:IntDimension):void
setMaximumSize(d:IntDimension)
setMaximumSize(width:Number, height:Number)

Set the maximumSize, then the component's maximumSize is specified.

Component
 Inherited
setMaximumWidth(maximumWidth:int):void
Sets maximum width, -1 means auto count.
Component
 Inherited
setMinimumHeight(minimumHeight:int):void
Sets minimum height, -1 means auto count.
Component
 Inherited
setMinimumSize(minimumSize:IntDimension):void
setMinimumSize(d:IntDimension)
setMinimumSize(width:Number, height:Number)

Set the minimumSize, then the component's minimumSize is specified.

Component
 Inherited
setMinimumWidth(minimumWidth:int):void
Sets minimum width, -1 means auto count.
Component
 Inherited
setName(name:String):void
Sets the name of this component
Component
  
setOffsetX(offset:Number):void
Sets the x offset of the position of the loaded image/animation.
AssetPane
  
setOffsetY(offset:Number):void
Sets the y offset of the position of the loaded image/animation.
AssetPane
 Inherited
setOpaque(b:Boolean):void
If true the component paints every pixel within its bounds.
Component
 Inherited
setOpaqueSet(b:Boolean):void
This method will be called to set true when you set the opaque by setOpaque().
Component
 Inherited
setPreferredHeight(preferredHeight:int):void
Sets preferred width, -1 means auto count.
Component
 Inherited
setPreferredSize(preferredSize:IntDimension):void
setPreferredSize(d:IntDimension)
setPreferredSize(width:Number, height:Number)

Set the preferredSize, then the component's preferredSize is specified.

Component
 Inherited
setPreferredWidth(preferredWidth:int):void
Sets preferred width, -1 means auto count.
Component
  
setPrefferSizeStrategy(p:Number):void
Sets the preffered size counting strategy.
AssetPane
  
setScaleMode(mode:int):void
Sets new content scale mode.
AssetPane
 Inherited
setSize(newSize:IntDimension):void
Set the component's size, the width and height all will be setted to not less than zero, then set the size.
Component
 Inherited
setSizeWH(w:int, h:int):void
Component
 Inherited
setToolTipText(t:String):void
Registers the text to display in a tool tip.
Component
 Inherited
setUI(newUI:ComponentUI):void
Sets the look and feel delegate for this component.
Component
 Inherited
setUIElement(b:Boolean):void
Sets the component is a ui element or not.
Component
  
setVerticalAlignment(alignment:int):void
Sets the vertical alignment of the image/animation.
AssetPane
 Inherited
setVisible(v:Boolean):void
Set a component to be hide or shown.
Component
 Inherited
setWidth(width:int):void
Sets the component's width.
Component
 Inherited
setX(x:int):void
Sets the x coordinate of the components.
Component
 Inherited
setY(y:int):void
Sets the y coordinate of the components.
Component
 Inherited
swapChildren(child1:DisplayObject, child2:DisplayObject):void
AWSprite
 Inherited
swapChildrenAt(index1:int, index2:int):void
AWSprite
 Inherited
toString():String
Component
 Inherited
transferFocus():Boolean
Transfers the focus to the next component, as though this Component were the focus owner.
Component
 Inherited
Transfers the focus to the previous component, as though this Component were the focus owner.
Component
  
unloadAsset():void
unload the asset of the pane
AssetPane
 Inherited
updateUI():void
Resets the UI property to a value from the current look and feel.
Component
 Inherited
validate():void
Validates this container and all of its subcomponents.
Container
Protected Methods
 MethodDefined by
  
AssetPane
 Inherited
Component
 Inherited
call the ui, if ui return null, ehn call layout to count.
Container
 Inherited
call the ui, if ui return null, ehn call layout to count.
Container
  
count preffered size base on prefferSizeStrategy.
AssetPane
 Inherited
d_addChild(child:DisplayObject):DisplayObject
AWSprite
 Inherited
d_addChildAt(child:DisplayObject, index:int):DisplayObject
AWSprite
 Inherited
d_getChildAt(index:int):DisplayObject
AWSprite
 Inherited
d_getChildByName(name:String):DisplayObject
AWSprite
 Inherited
d_getChildIndex(child:DisplayObject):int
AWSprite
 Inherited
d_removeChild(child:DisplayObject):DisplayObject
AWSprite
 Inherited
d_removeChildAt(index:int):DisplayObject
AWSprite
 Inherited
d_setChildIndex(child:DisplayObject, index:int):void
AWSprite
 Inherited
d_swapChildren(child1:DisplayObject, child2:DisplayObject):void
AWSprite
 Inherited
d_swapChildrenAt(index1:int, index2:int):void
AWSprite
 Inherited
getBackgroundChild():DisplayObject
Returns the background child.
AWSprite
 Inherited
Container
 Inherited
Container
 Inherited
Override this to return another component that the focus should be transmit to.
Component
 Inherited
getForegroundChild():DisplayObject
Returns the foreground child.
AWSprite
 Inherited
insertImp(i:int, com:Component, constraints:Object = null):void
Container
 Inherited
Makes this component and all parents above it are marked as needing to be laid out.
Component
 Inherited
isChild(child:DisplayObject):Boolean
Returns whether or not the child is this sprite's direct child.
AWSprite
  
loadFloor():void
load the floor content.
AssetPane
 Inherited
locate():void
Locate the component to the current location.
Component
 Inherited
draw the component interface in specified bounds.
Component
 Inherited
Container
  
resetAsset():void
AssetPane
  
AssetPane
 Inherited
setBackgroundChild(child:DisplayObject = null):void
Sets the child to be the component background, it will be add to the bottom of all other children.
AWSprite
 Inherited
AWSprite
 Inherited
setForegroundChild(child:DisplayObject = null):void
Sets the child to be the component foreground, it will be add to the top of all other children.
AWSprite
  
setLoaded(b:Boolean):void
AssetPane
 Inherited
size():void
Do the process when size changed.
Component
  
AssetPane
Events
 EventSummaryDefined by
 Inherited Dispatched when the component is clicked continuesly.Component
 Inherited Dispatched when a component is added to a container.Container
 Inherited Dispatched when a component is removed from a container.Container
 Inherited Dispatched when a drag is drop on this component.Component
 Inherited Dispatched when a drag is enter this component area.Component
 Inherited Dispatched when a drag is exit this component area.Component
 Inherited Dispatched when the component is recongnized that it can be drag start.Component
 Inherited Dispatched when the component gained the focus from it is not the focus owner Component
 Inherited Dispatched when the key down and the component is the focus owner.Component
 Inherited Dispatched when the key up and the component is the focus owner.Component
 Inherited Dispatched when the component lost the focus from it was the focus owner.Component
 Inherited Dispatched when the component visible is set to false from true.Component
 Inherited Dispatched when the component is moved.Component
 Inherited Dispatched when the component is painted.Component
 Inherited Dispatched when the mouse released or released out side.AWSprite
 Inherited Dispatched only when the mouse released out side.AWSprite
 Inherited Dispatched when the component is resized.Component
 Inherited Dispatched when the component visible is set to true from false.Component
Public Constants
 ConstantDefined by
  BOTTOM : int = 3
[static] A fast access to AsWingConstants Constant
AssetPane
  CENTER : int = 0
[static] A fast access to AsWingConstants Constant
AssetPane
  LEFT : int = 2
[static] A fast access to AsWingConstants Constant
AssetPane
  PREFER_SIZE_BOTH : int = 0
[static] preffered size of this component will be the fit to contain both size of extenal image/animation and counted from LayoutManager
AssetPane
  PREFER_SIZE_IMAGE : int = 1
[static] preffered size of this component will be the size of extenal image/animation
AssetPane
  PREFER_SIZE_LAYOUT : int = 2
[static] preffered size of this component will be counted by LayoutManager
AssetPane
  RIGHT : int = 4
[static] A fast access to AsWingConstants Constant
AssetPane
  SCALE_CUSTOM : int = 5
[static] Custom scaling of the image.
AssetPane
  SCALE_FIT_HEIGHT : int = 4
[static] Proportional scale mode to fit pane's height.
AssetPane
  SCALE_FIT_PANE : int = 1
[static] Proportional scale mode to fit pane.
AssetPane
  SCALE_FIT_WIDTH : int = 3
[static] Proportional image scale mode to fit pane's width.
AssetPane
  SCALE_NONE : int = 0
[static] Image scale mode is disabled.
AssetPane
  SCALE_STRETCH_PANE : int = 2
[static] Stretch content to fill whole pane.
AssetPane
  TOP : int = 1
[static] A fast access to AsWingConstants Constant
AssetPane
Property detail
assetproperty
protected var asset:DisplayObject
assetContainerproperty 
protected var assetContainer:DisplayObjectContainer
assetMaskproperty 
protected var assetMask:Shape
Constructor detail
AssetPane()constructor
public function AssetPane(asset:DisplayObject = null, prefferSizeStrategy:int)

AssetPane(path:String, prefferSizeStrategy:int)
AssetPane(path:String) prefferSizeStrategy default to PREFER_SIZE_BOTH
AssetPane() path default to null,prefferSizeStrategy default to PREFER_SIZE_IMAGE

Creates a AssetPane with a path to load external content.

Parameters
asset:DisplayObject (default = null) — the asset to be placed on this pane.
 
prefferSizeStrategy:int — the prefferedSize count strategy. Must be one of below:
  • {

See also

Method detail
applyMaskAsset()method
protected function applyMaskAsset():void
countPreferredSize()method 
protected override function countPreferredSize():IntDimension

count preffered size base on prefferSizeStrategy.

Returns
IntDimension
doLayout()method 
public override function doLayout():void

layout this container

getActualScale()method 
public function getActualScale():int

Returns current actual scale value in percents. If scaleMode is #SCALE_STRETCH_PANE returns null.

Returns
int
getAsset()method 
public function getAsset():DisplayObject

Returns the asset of the pane.

You should take care to do operation at this display object, if you want to remove it, you should call setAsset(null) instead of call asset.parent.removeChild(asset);

Returns
DisplayObject — the asset.
getAssetOriginalSize()method 
public function getAssetOriginalSize():IntDimension

Returns the asset's original size. If the asset are not loaded yet, return null.

Returns
IntDimension — the asset original size. null if it is not loaded yet.
getCustomScale()method 
public function getCustomScale():int

Returns current custom scale value in percents.

Returns
int
getHorizontalAlignment()method 
public function getHorizontalAlignment():Number

Returns the horizontal alignment of the image/animation.

Returns
Number — the horizontalAlignment property, one of the following values:
  • AsWingConstants.RIGHT (the default)
  • AsWingConstants.LEFT
  • AsWingConstants.CENTER
Default is LEFT.
getOffsetX()method 
public function getOffsetX():Number

Returns
Number

See also

getOffsetY()method 
public function getOffsetY():Number

Returns
Number

See also

getPrefferSizeStrategy()method 
public function getPrefferSizeStrategy():Number

Returns the preffered size counting strategy.

Returns
Number

See also

getScaleMode()method 
public function getScaleMode():int

Returns current image scale mode.

Returns
int — current image scale mode.
  • {
getVerticalAlignment()method 
public function getVerticalAlignment():Number

Returns the vertical alignment of the image/animation.

Returns
Number — the verticalAlignment property, one of the following values:
  • AsWingConstants.CENTER (the default)
  • AsWingConstants.TOP
  • AsWingConstants.BOTTOM
isAssetVisible()method 
public function isAssetVisible():Boolean

Returns the asset visible property.

Returns
Boolean — the asset visible property.
isLoaded()method 
public function isLoaded():Boolean

Returns is the asset was loaded ok.

Returns
Boolean — true if the asset loaded ok, otherwise return false
isMaskAsset()method 
public function isMaskAsset():Boolean

Returns
Boolean
loadFloor()method 
protected function loadFloor():void

load the floor content.

here it is empty. Subclass must override this method to make loading.

reload()method 
public function reload():void

Reload the asset. This will reset the asset to count currenty size and re-layout.

See also

resetAsset()method 
protected function resetAsset():void
setAsset()method 
public function setAsset(asset:DisplayObject):void

set the asset of the pane This method will cause old asset to be removed and new asset to be added.

Parameters
asset:DisplayObject — the asset of the pane.
setAssetOriginalSize()method 
protected function setAssetOriginalSize(size:IntDimension):voidParameters
size:IntDimension
setAssetVisible()method 
public function setAssetVisible(b:Boolean):void

Sets the visible of the assets.

Parameters
b:Boolean — the visible property.
setCustomScale()method 
public function setCustomScale(scale:int):void

Sets new custom scale value in percents. Automatically turns scale mode into #SCALE_CUSTOM.

Parameters
scale:int — the new scale

See also

setHorizontalAlignment()method 
public function setHorizontalAlignment(alignment:int):void

Sets the horizontal alignment of the image/animation.

Parameters
alignment:int — one of the following values:
  • AsWingConstants.RIGHT (the default)
  • AsWingConstants.LEFT
  • AsWingConstants.CENTER
setLoaded()method 
protected function setLoaded(b:Boolean):voidParameters
b:Boolean
setMaskAsset()method 
public function setMaskAsset(m:Boolean):voidParameters
m:Boolean
setOffsetX()method 
public function setOffsetX(offset:Number):void

Sets the x offset of the position of the loaded image/animation. If you dont want to locate the content to the topleft of the pane, you can set the offsets.

Parameters
offset:Number — the x offset
setOffsetY()method 
public function setOffsetY(offset:Number):void

Sets the y offset of the position of the loaded image/animation. If you dont want to locate the content to the topleft of the pane, you can set the offsets.

Parameters
offset:Number — the y offset
setPrefferSizeStrategy()method 
public function setPrefferSizeStrategy(p:Number):void

Sets the preffered size counting strategy. Must be one of below:

setScaleMode()method 
public function setScaleMode(mode:int):void

Sets new content scale mode.

Note:Take care to use #scaleMode to load a swf, because swf has different size at different frame or when some symbol invisible/visible. Parameters

mode:int — the new image scale mode.
  • {
setVerticalAlignment()method 
public function setVerticalAlignment(alignment:int):void

Sets the vertical alignment of the image/animation.

Parameters
alignment:int — one of the following values:
  • AsWingConstants.CENTER (the default)
  • AsWingConstants.TOP
  • AsWingConstants.BOTTOM
Default is CENTER.
storeOriginalScale()method 
protected function storeOriginalScale():void
unloadAsset()method 
public function unloadAsset():void

unload the asset of the pane

Constant detail
BOTTOMconstant
public static const BOTTOM:int = 3

A fast access to AsWingConstants Constant

See also

CENTERconstant 
public static const CENTER:int = 0

A fast access to AsWingConstants Constant

See also

LEFTconstant 
public static const LEFT:int = 2

A fast access to AsWingConstants Constant

See also

PREFER_SIZE_BOTHconstant 
public static const PREFER_SIZE_BOTH:int = 0

preffered size of this component will be the fit to contain both size of extenal image/animation and counted from LayoutManager

PREFER_SIZE_IMAGEconstant 
public static const PREFER_SIZE_IMAGE:int = 1

preffered size of this component will be the size of extenal image/animation

PREFER_SIZE_LAYOUTconstant 
public static const PREFER_SIZE_LAYOUT:int = 2

preffered size of this component will be counted by LayoutManager

RIGHTconstant 
public static const RIGHT:int = 4

A fast access to AsWingConstants Constant

See also

SCALE_CUSTOMconstant 
public static const SCALE_CUSTOM:int = 5

Custom scaling of the image.

See also

setCustomScale
SCALE_FIT_HEIGHTconstant 
public static const SCALE_FIT_HEIGHT:int = 4

Proportional scale mode to fit pane's height.

SCALE_FIT_PANEconstant 
public static const SCALE_FIT_PANE:int = 1

Proportional scale mode to fit pane.

SCALE_FIT_WIDTHconstant 
public static const SCALE_FIT_WIDTH:int = 3

Proportional image scale mode to fit pane's width.

SCALE_NONEconstant 
public static const SCALE_NONE:int = 0

Image scale mode is disabled.

SCALE_STRETCH_PANEconstant 
public static const SCALE_STRETCH_PANE:int = 2

Stretch content to fill whole pane.

TOPconstant 
public static const TOP:int = 1

A fast access to AsWingConstants Constant

See also