Package | com.gestureworks.cml.elements |
Class | public class Hotspot |
Inheritance | Hotspot ![]() ![]() ![]() |
See also
Property | Defined By | ||
---|---|---|---|
![]() | autoShuffle : Boolean
autoshuffles
| TouchContainer | |
![]() | childList : ChildList
Returns the object's childList. | TouchContainer | |
![]() | className : String
sets the class name of displayobject
| TouchContainer | |
![]() | cloneExclusions : Vector.<String> [read-only]
Returns a list of properties to exclude when cloning this object
| TouchContainer | |
![]() | cmlIndex : int
Returns the index created by the CML parser. | TouchContainer | |
compAbsPos : Boolean = false | Hotspot | ||
compAddOnOpen : Boolean = false | Hotspot | ||
compCenterToStage : Boolean = false | Hotspot | ||
component : *
The component CSS id to attach this hotspot to. | Hotspot | ||
componentAnchorOffsetX : Number
X offset to where the tether sprite is anchored on the component
| Hotspot | ||
componentAnchorOffsetY : Number
Y offset to where the tether sprite is anchored on the component
| Hotspot | ||
compResetOnClose : Boolean = false | Hotspot | ||
compResetOnOpen : Boolean = false | Hotspot | ||
compTween : Boolean = false | Hotspot | ||
compTweenTime : Number = .25 | Hotspot | ||
compX : Number = 0 | Hotspot | ||
compY : Number = 0 | Hotspot | ||
![]() | dimensionsTo : Object
Sets the dimensions of TouchContainer to given object
| TouchContainer | |
![]() | dropShadow : Boolean
Sets the drop shadow effect
| TouchContainer | |
![]() | group : String | TouchContainer | |
![]() | height : Number [override]
sets the height of the container
| TouchContainer | |
![]() | heightPercent : Number
sets the height of the container
| TouchContainer | |
![]() | id : String
Returns the object's id. | TouchContainer | |
![]() | layout : *
specifies the type of layout
| TouchContainer | |
![]() | layoutList : Dictionary | TouchContainer | |
![]() | mouseChildren : Boolean [override]
sets the mousechildren value to true or false. | TouchContainer | |
![]() | paddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area. | TouchContainer | |
![]() | paddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area. | TouchContainer | |
![]() | paddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area. | TouchContainer | |
![]() | paddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area. | TouchContainer | |
![]() | position : *
Sets the position
| TouchContainer | |
![]() | relativeX : Boolean
When set true this containers children's x position will be laid out relatively
to each other. | TouchContainer | |
![]() | relativeY : Boolean
When set true this containers children's y position will be laid out relatively
to each other. | TouchContainer | |
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 | ||
![]() | sound : String | TouchContainer | |
![]() | state : Dictionary | TouchContainer | |
![]() | stateId : *
Returns the current state id. | TouchContainer | |
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 | ||
tetherOffsetX : Number
X offset to the source of the tether sprite
| Hotspot | ||
tetherOffsetY : Number
Y offset to the source of the tether sprite
| Hotspot | ||
tetherStroke : Number
The stroke of the tethering line. | Hotspot | ||
![]() | toBitmap : Boolean | TouchContainer | |
![]() | width : Number [override]
sets the width of the container
| TouchContainer | |
![]() | widthPercent : Number
sets the width of the container
| TouchContainer |
Property | Defined By | ||
---|---|---|---|
![]() | cmlGestureList : Object | TouchContainer | |
tetherSprite : Sprite | Hotspot |
Method | Defined By | ||
---|---|---|---|
Hotspot()
Constructor
| Hotspot | ||
![]() | activateTouch():void | TouchContainer | |
![]() | addAllChildren():void
method searches the child and adds to the list
| TouchContainer | |
![]() | addChild(child:DisplayObject):DisplayObject [override]
Adds child to display list and, if not already added, the child list
| TouchContainer | |
![]() | addChildAt(child:DisplayObject, index:int):DisplayObject [override]
Adds child to display list and, if not already added, the child list
| TouchContainer | |
![]() | applyLayout(value:* = null):void
Apply the containers layout
| TouchContainer | |
![]() | childToList(id:String, child:*):void
child appended to the childlist
| TouchContainer | |
![]() | clone():*
Clone method
| TouchContainer | |
dispose():void [override]
Destructor
| Hotspot | ||
![]() | getElementById(id:String):*
Searches CML childList by id. | TouchContainer | |
![]() | getElementsByClassName(className:String):Array
Searches the CML childList by className. | TouchContainer | |
![]() | getElementsByTagName(tagName:Class):Array
Searches the CML childList by tagName as Class. | TouchContainer | |
init():void [override]
Initialisation method
| Hotspot | ||
![]() | loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number. | TouchContainer | |
![]() | makeGestureList(value:XMLList):Object
Creates gestureList object from XML
| TouchContainer | |
![]() | parseCML(cml:XMLList):XMLList
Parse cml for local layouts. | TouchContainer | |
![]() | postparseCML(cml:XMLList):void
Abstract method allows the setting of a postparse CML routine. | TouchContainer | |
![]() | querySelector(selector:String):*
Searches the CML childList by selector. | TouchContainer | |
![]() | querySelectorAll(selector:*):Array
Search the CML childList by selector. | TouchContainer | |
![]() | removeChild(child:DisplayObject):DisplayObject [override]
Removes child from display list and, if not already removed, the child list
| TouchContainer | |
![]() | removeChildAt(index:int):DisplayObject [override]
Removes child from display list and, if not already removed, the child list
| TouchContainer | |
![]() | removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void [override]
Removes children from display list and, if not already removed, the child list
| TouchContainer | |
![]() | saveState(sId:* = null, recursion:Boolean = false):void
Save state by index number. | TouchContainer | |
![]() | searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists. | TouchContainer | |
![]() | setDimensionsToChild():void
method sets the dimensions of each child
| TouchContainer | |
![]() | tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index. | TouchContainer | |
![]() | updatePadding():void
Updates child padding within this container
| TouchContainer | |
![]() | updatePercentDim():void
Updates child percent dimensions within this container
| TouchContainer | |
![]() | updateProperties(state:* = 0):void
Updates properties from state. | TouchContainer | |
![]() | updateRelativePos():void
Updates child relative positions within this container
| TouchContainer |
Method | Defined By | ||
---|---|---|---|
onEnterFrame(e:Event):void | Hotspot | ||
onHotspot(e:StateEvent):void | Hotspot |
compAbsPos | property |
public var compAbsPos:Boolean = false
compAddOnOpen | property |
public var compAddOnOpen: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
componentAnchorOffsetX | property |
componentAnchorOffsetX:Number
X offset to where the tether sprite is anchored on the component
public function get componentAnchorOffsetX():Number
public function set componentAnchorOffsetX(value:Number):void
componentAnchorOffsetY | property |
componentAnchorOffsetY:Number
Y offset to where the tether sprite is anchored on the component
public function get componentAnchorOffsetY():Number
public function set componentAnchorOffsetY(value:Number):void
compResetOnClose | property |
public var compResetOnClose:Boolean = false
compResetOnOpen | property |
public var compResetOnOpen:Boolean = false
compTween | property |
public var compTween:Boolean = false
compTweenTime | property |
public var compTweenTime:Number = .25
compX | property |
public var compX:Number = 0
compY | property |
public var compY:Number = 0
sceneX | property |
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).
public function get sceneX():Number
public function set sceneX(value:Number):void
sceneY | property |
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).
public function get sceneY():Number
public function set sceneY(value:Number):void
tether | property |
tether:Boolean
Whether 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:Number
The alpha of the tethering line.
public function get tetherAlpha():Number
public function set tetherAlpha(value:Number):void
tetherColor | property |
tetherColor:uint
The color of the tethering line if set to true.
public function get tetherColor():uint
public function set tetherColor(value:uint):void
tetherOffsetX | property |
tetherOffsetX:Number
X offset to the source of the tether sprite
public function get tetherOffsetX():Number
public function set tetherOffsetX(value:Number):void
tetherOffsetY | property |
tetherOffsetY:Number
Y offset to the source of the tether sprite
public function get tetherOffsetY():Number
public function set tetherOffsetY(value:Number):void
tetherSprite | property |
protected var tetherSprite:Sprite
tetherStroke | property |
tetherStroke:Number
The stroke of the tethering line.
public function get tetherStroke():Number
public function set tetherStroke(value:Number):void
Hotspot | () | Constructor |
public function Hotspot()
Constructor
dispose | () | method |
override public function dispose():void
Destructor
init | () | method |
override public function init():void
Initialisation method
onEnterFrame | () | method |
protected function onEnterFrame(e:Event):void
Parameters
e:Event |
onHotspot | () | method |