| Package | com.gestureworks.cml.kits |
| Class | public class BackgroundKit |
| Inheritance | BackgroundKit  Container ContainerFactory ElementFactory flash.display.Sprite |
var bg:BackgroundKit = new BackgroundKit;
bg.addChild(img1);
bg.addChild(img2);
bg.init();
bg.addChild();
See also
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number [override] [write-only]
sets the alpha for display objects
| ElementFactory | |
| _autoupdate : Boolean = false
Automatically updates background to stage size. | BackgroundKit | ||
| autoupdate : Boolean | BackgroundKit | ||
| blur : Boolean
Sets the drop shadow effect
| ElementFactory | |
| bottom : Number
sets the bottom value
| ElementFactory | |
| childList : ChildList [read-only]
store the child list
| ContainerFactory | |
| class_ : String
Object's css class;
| ElementFactory | |
| className : String
sets the class name of displayobject
| ElementFactory | |
| cmlIndex : int
sets the cml index
| ElementFactory | |
| debugStyle : *
sets the debug style
| ElementFactory | |
| dimensionsTo : String
sets the dimensions of the container
| ContainerFactory | |
| displayEvents : String
Use for dispatch completes. | ElementFactory | |
| dropShadow : Boolean
Sets the drop shadow effect
| ElementFactory | |
| height : Number [override]
Sets width of the display object in pixels
| ElementFactory | |
| heightPercent : String
sets the height percent of display object
| ElementFactory | |
| horizontalCenter : Number
sets the horizontal center of display object
| ElementFactory | |
| id : String
sets the id of child
| ElementFactory | |
| index : int
sets the index of display object
| ElementFactory | |
| infoSource : String
sets info source
| ContainerFactory | |
| layout : *
Sets the layout of the container
| Container | |
| layoutComplete : Function
Sets the function to call when the layout is complete
| Container | |
| layoutList : Dictionary
Defines the layoutlist
| Container | |
| layoutUpdate : Function
Sets the function to call when the layout updates
| Container | |
| left : Number
sets left value
| ElementFactory | |
| paddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area. | Container | |
| paddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area. | Container | |
| paddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area. | Container | |
| paddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area. | Container | |
| position : String
Sets the position
| Container | |
| propertyStates : Array Deprecated: Please Use state | ElementFactory | |
| right : Number
sets the right value
| ElementFactory | |
| scale : Number
Sets both the x and y scale values
| ElementFactory | |
| scaleX : Number [override]
Sets width of the display object in pixels
| ElementFactory | |
| scaleY : Number [override]
Sets width of the display object in pixels
| ElementFactory | |
| state : Array
property states array
| ElementFactory | |
| top : Number
sets top value
| ElementFactory | |
| verticalCenter : Number
sets the vertical center of display object
| ElementFactory | |
| width : Number [override]
Sets width of the display object in pixels
| ElementFactory | |
| widthPercent : String
sets the percent of width of display object
| ElementFactory | |
| Method | Defined By | ||
|---|---|---|---|
Constructor
| BackgroundKit | ||
| addAllChildren():void
This method searches the childlist and add the children
| ContainerFactory | |
| addChild(child:DisplayObject):DisplayObject [override]
Adds child to display list and, if not already added, the child list
TODO: This mechanism should be abstracted to better syncrhonize child and display lists
| Container | |
| applyLayout(value:* = null):void
Apply the containers layout
| Container | |
| childToList(id:String, child:*):void
this method append to the childlist
| ContainerFactory | |
| clone():*
Returns clone of self
| ElementFactory | |
displayComplete():void [override]
Initialisation method
| BackgroundKit | ||
dispose():void [override]
Dispose method
| BackgroundKit | ||
| getIndex(index:int):*
returns childlist index
| Container | |
| getKey(key:String):*
returns the childlist key
| Container | |
| hideIndex(index:int):void
hides the childlist index
| Container | |
| hideKey(key:String):void
hides the childlist key
| Container | |
init():void [override]
CML callback initialisation
| BackgroundKit | ||
| parseCML(cml:XMLList):XMLList [override]
Parse cml for local layouts. | Container | |
| postparseCML(cml:XMLList):void
post parses the cml file
| ElementFactory | |
| searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists. | Container | |
| setDimensionsToChild():void
This method sets the dimensions of childlist
| ContainerFactory | |
| showIndex(index:int):void
shows the childlist index
| Container | |
| showKey(key:String):void
shows the childlist key
| Container | |
updateLayout(event:Event = null):void
Updates the child x and y position to the center of the stage
| BackgroundKit | ||
| updateProperties(state:Number = 0):void
this method updates the properties
| ElementFactory | |
| _autoupdate | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var _autoupdate:Boolean = falseAutomatically updates background to stage size. This adds an event listener to the stage which listens for resize events, and adjust accordingly.
The default value is false.
| autoupdate | property |
autoupdate:Boolean public function get autoupdate():Boolean public function set autoupdate(value:Boolean):void| BackgroundKit | () | Constructor |
public function BackgroundKit()Constructor
| displayComplete | () | method |
override public function displayComplete():voidInitialisation method
| dispose | () | method |
override public function dispose():voidDispose method
| init | () | method |
override public function init():voidCML callback initialisation
| updateLayout | () | method |
public function updateLayout(event:Event = null):voidUpdates the child x and y position to the center of the stage
Parameters
event:Event (default = null) |