| Package | com.gestureworks.cml.element |
| Class | public class Hotspot |
| Inheritance | Hotspot  Container ContainerFactory ElementFactory flash.display.Sprite |
See also
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number [override] [write-only]
sets the alpha for display objects
| ElementFactory | |
| 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 | |
| compAbsPos : Boolean = false | Hotspot | ||
| compCenterToStage : Boolean = false | Hotspot | ||
| component : *
The component CSS id to attach this hotspot to. | Hotspot | ||
| compResetOnClose : Boolean = false | Hotspot | ||
| compResetOnOpen : Boolean = false | Hotspot | ||
| compX : Number = 0 | Hotspot | ||
| compY : Number = 0 | Hotspot | ||
| 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 | |
| sceneX : Number
The relative _x coordinate to be attached to on the scene of an object that does not use regular stage coordinates (ie: gigapixel). | Hotspot | ||
| sceneY : Number
the relative _y coordinate to be attached to on the scene of an object that does not use regular stage coordinates (ie: gigapixel). | Hotspot | ||
| state : Array
property states array
| ElementFactory | |
| tether : Boolean
Whether or not a tethering line will be drawn from the hotspot graphic to the component. | Hotspot | ||
| tetherAlpha : Number
The alpha of the tethering line. | Hotspot | ||
| tetherColor : uint
The color of the tethering line if set to true. | Hotspot | ||
| tetherStroke : Number
The stroke of the tethering line. | Hotspot | ||
| 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 | ||
|---|---|---|---|
Hotspot()
Constructor
| Hotspot | ||
| 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]
CML callback Initialisation
| Hotspot | ||
dispose():void [override] | Hotspot | ||
| 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]
Initialisation method
| Hotspot | ||
| 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 | |
| updateProperties(state:Number = 0):void
this method updates the properties
| ElementFactory | |
| compAbsPos | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var compAbsPos:Boolean = false| compCenterToStage | property |
public var compCenterToStage:Boolean = false| component | property |
component:*The component CSS id to attach this hotspot to. Attaching a component to a hotspot that is a button will toggle the component's visibility. It is recommended that you set all items attached to the hotspot to visible="false" as their initial state.
public function get component():* public function set component(value:any):void| compResetOnClose | property |
public var compResetOnClose:Boolean = false| compResetOnOpen | property |
public var compResetOnOpen:Boolean = false| compX | property |
public var compX:Number = 0| compY | property |
public var compY:Number = 0| sceneX | property |
sceneX:NumberThe relative _x coordinate to be attached to on the scene of an object that does not use regular stage coordinates (ie: gigapixel).
public function get sceneX():Number public function set sceneX(value:Number):void| sceneY | property |
sceneY:Numberthe relative _y coordinate to be attached to on the scene of an object that does not use regular stage coordinates (ie: gigapixel).
public function get sceneY():Number public function set sceneY(value:Number):void| tether | property |
tether:BooleanWhether or not a tethering line will be drawn from the hotspot graphic to the component.
public function get tether():Boolean public function set tether(value:Boolean):void| tetherAlpha | property |
tetherAlpha:NumberThe alpha of the tethering line.
public function get tetherAlpha():Number public function set tetherAlpha(value:Number):void| tetherColor | property |
tetherColor:uintThe color of the tethering line if set to true.
public function get tetherColor():uint public function set tetherColor(value:uint):void| tetherStroke | property |
tetherStroke:NumberThe stroke of the tethering line.
public function get tetherStroke():Number public function set tetherStroke(value:Number):void| Hotspot | () | Constructor |
public function Hotspot()Constructor
| displayComplete | () | method |
override public function displayComplete():voidCML callback Initialisation
| dispose | () | method |
override public function dispose():void| init | () | method |
override public function init():voidInitialisation method