AssetPane

Abstract class for A container with a decorative asset.

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

@see JLoadPane

@author paling @author ngrebenshikov

Class Fields

`static var BOTTOM:Int`

A fast access to AsWingConstants Constant @see AsWingConstants

`static var CENTER:Int`

A fast access to AsWingConstants Constant @see AsWingConstants

`static var LEFT:Int`

A fast access to AsWingConstants Constant @see AsWingConstants

`static var PREFER_SIZE_BOTH:Int`

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

`static var PREFER_SIZE_IMAGE:Int`

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

`static var PREFER_SIZE_LAYOUT:Int`

preffered size of this component will be counted by LayoutManager

`static var RIGHT:Int`

A fast access to AsWingConstants Constant @see AsWingConstants

`static var SCALE_CUSTOM:Int`

Custom scaling of the image. @see AssetPane.setCustomScale

`static var SCALE_FIT_HEIGHT:Int`

Proportional scale mode to fit pane's height.

`static var SCALE_FIT_PANE:Int`

Proportional scale mode to fit pane.

`static var SCALE_FIT_WIDTH:Int`

Proportional image scale mode to fit pane's width.

`static var SCALE_NONE:Int`

Image scale mode is disabled.

`static var SCALE_STRETCH_PANE:Int`

Stretch content to fill whole pane.

`static var TOP:Int`

A fast access to AsWingConstants Constant @see AsWingConstants

Instance Fields

Show inherited public instance fields

Hide inherited public instance fields

Inherited from Container

var layout:LayoutManager

function append(com:Component, ?constraints:Dynamic):Void

function appendAll(coms:Array<Dynamic>):Void

function doLayout():Void

function getComponent(index:Int):Component

function getComponentCount():Int

function getComponents():Array<Dynamic>

function getFocusTraversalPolicy():FocusTraversalPolicy

function getIndex(com:Component):Int

function getLayout():LayoutManager

function insert(i:Int, com:Component, ?constraints:Dynamic):Void

function insertAll(index:Int, coms:Array<Dynamic>):Void

function invalidate():Void

function isAncestorOf(c:Component):Bool

function reAppendChildren():Void

function remove(com:Component):Component

function removeAll():Void

function removeAt(i:Int):Component

function removeChild(child:DisplayObject):DisplayObject

function removeChildAt(index:Int):DisplayObject

function setFocusTraversalPolicy(ftp:FocusTraversalPolicy):Void

function setLayout(layout:LayoutManager):Void

function validate():Void

Inherited from Component

var __fieldBindings__:FieldsBindSignal

var __methodBindings__:MethodsBindSignal

var alignmentX:Float

var alignmentY:Float

var background:ASColor

var backgroundDecorator:GroundDecorator

var border:Border

var bounds:IntRectangle

var clipBounds:IntRectangle

var constraints:Dynamic

var currentSize:IntDimension

var dragEnabled:Bool

var dropTrigger:Bool

var enabled:Bool

var focusable:Bool

var focusableSet:Bool

var font:ASFont

var foreground:ASColor

var foregroundDecorator:GroundDecorator

var location:IntPoint

var maximumSize:IntDimension

var mideground:ASColor

var minimumSize:IntDimension

var opaque:Bool

var opaqueSet:Bool

var preferredSize:IntDimension

var resizerMargin:Insets

var styleProxy:Component

var styleTune:StyleTune

var toolTipText:String

var transitFocusFactor:Float

var ui:ComponentUI

var uiElement:Bool

var visibility:Bool

function addDragAcceptableInitiator(com:Component):Void

function componentToGlobal(p:IntPoint):IntPoint

function getClientProperty(key:String, ?defaultValue:Dynamic):Dynamic

function getDefaultBasicUIClass():Class<Dynamic>

function getFocusManager():FocusManager

function getGlobalLocation(?rv:IntPoint):IntPoint

function getInsets():Insets

function getInternalFocusObject():InteractiveObject

function getKeyboardManager():KeyboardManager

function getMousePosition():IntPoint

function getPaintBounds():IntRectangle

function getParent():Container

function getRootPaneAncestor():JRootPane

function getUIClassID():String

function globalToComponent(p:IntPoint):IntPoint

function hitTestMouse():Bool

function invalidate():Void

function invalidatePreferSizeCaches():Void

function isCachePreferSizes():Bool

function isDragAcceptableInitiator(com:Component):Bool

function isFocusOwner():Bool

function isFontValidated():Bool

function isOnStage():Bool

function isShowing():Bool

function isValid():Bool

function isValidateRoot():Bool

function makeFocus():Void

function pack():Void

function paintFocusRect(?force:Bool):Void

function paintImmediately():Void

function parentReAppendChildren():Void

function putClientProperty(key:String, value:Dynamic):Void

function reAppendToParent(?constraints:Dynamic):Void

function removeDragAcceptableInitiator(com:Component):Void

function removeFromContainer():Void

function repaint():Void

function repaintAndRevalidate():Void

function requestFocus():Bool

function revalidate():Void

function setCachePreferSizes(b:Bool):Void

function setClipSize(size:IntDimension):Void

function setDragAcceptableInitiatorAppraiser(func:Dynamic ->Bool):Void

function setFontValidated(b:Bool):Void

function setGlobalLocation(gp:IntPoint):Void

function transferFocus():Bool

function transferFocusBackward():Bool

function updateUI():Void

function validate():Void

Inherited from AWSprite

function bringToBottom(child:DisplayObject):Void

function bringToTop(child:DisplayObject):Void

function containsChild(child:DisplayObject):Bool

function getHighestIndexUnderForeground():Int

function getLowestIndexAboveBackground():Int

function isClipMasked():Bool

function setChildIndex(child:DisplayObject, index:Int):Void

function setClipMaskRect(b:IntRectangle):Void

function setClipMasked(m:Bool):Void

function toString():String

Inherited from Sprite

var buttonMode:Bool

var dropTarget:DisplayObject

var graphics:Graphics

var hitArea:Sprite

var soundTransform:SoundTransform

var useHandCursor:Bool

function startDrag(?lockCenter:Bool, ?bounds:Rectangle):Void

function startTouchDrag(touchPointID:Int, ?lockCenter:Bool, ?bounds:Rectangle):Void

function stopDrag():Void

function stopTouchDrag(touchPointID:Int):Void

Inherited from DisplayObjectContainer

var mouseChildren:Bool

var numChildren:Int

var tabChildren:Bool

var textSnapshot:TextSnapshot

function addChild(child:DisplayObject):DisplayObject

function addChildAt(child:DisplayObject, index:Int):DisplayObject

function areInaccessibleObjectsUnderPoint(point:Point):Bool

function contains(child:DisplayObject):Bool

function getChildAt(index:Int):DisplayObject

function getChildByName(name:String):DisplayObject

function getChildIndex(child:DisplayObject):Int

function getObjectsUnderPoint(point:Point):Array<DisplayObject>

function removeChild(child:DisplayObject):DisplayObject

function removeChildAt(index:Int):DisplayObject

function setChildIndex(child:DisplayObject, index:Int):Void

function swapChildren(child1:DisplayObject, child2:DisplayObject):Void

function swapChildrenAt(index1:Int, index2:Int):Void

Inherited from InteractiveObject

var accessibilityImplementation:AccessibilityImplementation

var contextMenu:ContextMenu

var doubleClickEnabled:Bool

var focusRect:Dynamic

var mouseEnabled:Bool

var tabEnabled:Bool

var tabIndex:Int

Inherited from DisplayObject

var accessibilityProperties:AccessibilityProperties

var alpha:Float

var blendMode:BlendMode

var blendShader:Shader

var cacheAsBitmap:Bool

var filters:Array<BitmapFilter>

var height:Float

var loaderInfo:LoaderInfo

var mask:DisplayObject

var mouseX:Float

var mouseY:Float

var name:String

var opaqueBackground:Null<UInt>

var parent:DisplayObjectContainer

var root:DisplayObject

var rotation:Float

var rotationX:Float

var rotationY:Float

var rotationZ:Float

var scale9Grid:Rectangle

var scaleX:Float

var scaleY:Float

var scaleZ:Float

var scrollRect:Rectangle

var stage:Stage

var transform:Transform

var visible:Bool

var width:Float

var x:Float

var y:Float

var z:Float

function getBounds(targetCoordinateSpace:DisplayObject):Rectangle

function getRect(targetCoordinateSpace:DisplayObject):Rectangle

function globalToLocal(point:Point):Point

function globalToLocal3D(point:Point):Vector3D

function hitTestObject(obj:DisplayObject):Bool

function hitTestPoint(x:Float, y:Float, ?shapeFlag:Bool):Bool

function local3DToGlobal(point3d:Vector3D):Point

function localToGlobal(point:Point):Point

Inherited from EventDispatcher

function addEventListener(type:String, listener:Dynamic ->Void?useCapture:Bool, ?priority:Int, ?useWeakReference:Bool):Void

function dispatchEvent(event:Event):Bool

function hasEventListener(type:String):Bool

function removeEventListener(type:String, listener:Dynamic ->Void?useCapture:Bool):Void

function toString():String

function willTrigger(type:String):Bool

`var actualScale:Null<Int>`

A readonly current actual scale value in percents. If AssetPane.scaleMode is AssetPane.SCALE_STRETCH_PANE returns null.

`var asset:DisplayObject`

The content

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

`var assetVisible:Bool`

`var clipEnabled:Bool`

`var customScale:Int`

The custom scale value in percents. Automatically turns scale mode into SCALE_CUSTOM. @see setScaleMode

`var horizontalAlignment:Int`

The horizontal alignment of the image/animation. Must be one of the following values:

AsWingConstants.RIGHT (the default)
AsWingConstants.LEFT
AsWingConstants.CENTER

`var offsetX:Float`

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.

`var offsetY:Float`

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.

`var prefferSizeStrategy:Int`

The preffered size counting strategy. Must be one of below:

AssetPane.PREFER_SIZE_BOTH
AssetPane.PREFER_SIZE_IMAGE
AssetPane.PREFER_SIZE_LAYOUT

`var scaleMode:Int`

The content scale mode.

AssetPane.SCALE_NONE
AssetPane.SCALE_FIT_PANE
AssetPane.SCALE_STRETCH_PANE
AssetPane.SCALE_FIT_WIDTH
AssetPane.SCALE_FIT_HEIGHT
AssetPane.SCALE_CUSTOM

`var verticalAlignment:Int`

The vertical alignment of the image/animation. Must be one of the following values:

AsWingConstants.CENTER (the default)
AsWingConstants.TOP
AsWingConstants.BOTTOM

`function new(?asset:DisplayObject = null, ?prefferSizeStrategy:Int = 1): Void`

Creates a AssetPane with a asset content.

@see AssetPane.asset

asset

the asset to be placed on this pane.

prefferSizeStrategy

the prefferedSize count strategy. Must be one of below:

AssetPane.PREFER_SIZE_BOTH
AssetPane.PREFER_SIZE_IMAGE
AssetPane.PREFER_SIZE_LAYOUT

`function doLayout(): Void`

Layout this container

`function getAssetOriginalSize(): IntDimension`

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

returns

the asset original size. null if it is not loaded yet.

`function isLoaded(): Bool`

Returns is the asset was loaded ok.

returns

true if the asset loaded ok, otherwise return false

`function reload(): Void`

Reload the asset. This will reset the asset to count currenty size and re-layout. See JLoadPane, JAttachPane

`function unloadAsset(): Void`

Unload the asset of the pane

class org.aswing.AssetPane extends Container

Class Fields

static var BOTTOM:Int

static var CENTER:Int

static var LEFT:Int

static var PREFER_SIZE_BOTH:Int

static var PREFER_SIZE_IMAGE:Int

static var PREFER_SIZE_LAYOUT:Int

static var RIGHT:Int

static var SCALE_CUSTOM:Int

static var SCALE_FIT_HEIGHT:Int

static var SCALE_FIT_PANE:Int

static var SCALE_FIT_WIDTH:Int

static var SCALE_NONE:Int

static var SCALE_STRETCH_PANE:Int

static var TOP:Int

Instance Fields

var actualScale:Null<Int>

var asset:DisplayObject

var assetVisible:Bool

var clipEnabled:Bool

var customScale:Int

var horizontalAlignment:Int

var offsetX:Float

var offsetY:Float

var prefferSizeStrategy:Int

var scaleMode:Int

var verticalAlignment:Int

function new(?asset:DisplayObject = null, ?prefferSizeStrategy:Int = 1): Void

function doLayout(): Void

function getAssetOriginalSize(): IntDimension

function isLoaded(): Bool

function reload(): Void

function unloadAsset(): Void

`class org.aswing.AssetPane extends Container`

`static var BOTTOM:Int`

`static var CENTER:Int`

`static var LEFT:Int`

`static var PREFER_SIZE_BOTH:Int`

`static var PREFER_SIZE_IMAGE:Int`

`static var PREFER_SIZE_LAYOUT:Int`

`static var RIGHT:Int`

`static var SCALE_CUSTOM:Int`

`static var SCALE_FIT_HEIGHT:Int`

`static var SCALE_FIT_PANE:Int`

`static var SCALE_FIT_WIDTH:Int`

`static var SCALE_NONE:Int`

`static var SCALE_STRETCH_PANE:Int`

`static var TOP:Int`

`var actualScale:Null<Int>`

`var asset:DisplayObject`

`var assetVisible:Bool`

`var clipEnabled:Bool`

`var customScale:Int`

`var horizontalAlignment:Int`

`var offsetX:Float`

`var offsetY:Float`

`var prefferSizeStrategy:Int`

`var scaleMode:Int`

`var verticalAlignment:Int`

`function new(?asset:DisplayObject = null, ?prefferSizeStrategy:Int = 1): Void`

`function doLayout(): Void`

`function getAssetOriginalSize(): IntDimension`

`function isLoaded(): Bool`

`function reload(): Void`

`function unloadAsset(): Void`