Packagecom.gestureworks.cml.elements
Classpublic class Hotspot
InheritanceHotspot Inheritance Container Inheritance TouchContainer Inheritance com.gestureworks.core.TouchSprite

A Hotspot is primarily a container for graphic objects that is set at an index local to a gigapixel scene.

See also

Gigapixel


Public Properties
 PropertyDefined By
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainer
 InheritedchildList : ChildList
Returns the object's childList.
TouchContainer
 InheritedclassName : String
sets the class name of displayobject
TouchContainer
 InheritedcloneExclusions : Vector.<String>
[read-only] Returns a list of properties to exclude when cloning this object
TouchContainer
 InheritedcmlIndex : 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
 InheriteddimensionsTo : Object
Sets the dimensions of TouchContainer to given object
TouchContainer
 InheriteddropShadow : Boolean
Sets the drop shadow effect
TouchContainer
 Inheritedgroup : String
TouchContainer
 Inheritedheight : Number
[override] sets the height of the container
TouchContainer
 InheritedheightPercent : Number
sets the height of the container
TouchContainer
 Inheritedid : String
Returns the object's id.
TouchContainer
 Inheritedlayout : *
specifies the type of layout
TouchContainer
 InheritedlayoutList : Dictionary
TouchContainer
 InheritedmouseChildren : Boolean
[override] sets the mousechildren value to true or false.
TouchContainer
 InheritedpaddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area.
TouchContainer
 InheritedpaddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area.
TouchContainer
 InheritedpaddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area.
TouchContainer
 InheritedpaddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area.
TouchContainer
 Inheritedposition : *
Sets the position
TouchContainer
 InheritedrelativeX : Boolean
When set true this containers children's x position will be laid out relatively to each other.
TouchContainer
 InheritedrelativeY : 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
 Inheritedsound : String
TouchContainer
 Inheritedstate : Dictionary
TouchContainer
 InheritedstateId : *
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
 InheritedtoBitmap : Boolean
TouchContainer
 Inheritedwidth : Number
[override] sets the width of the container
TouchContainer
 InheritedwidthPercent : Number
sets the width of the container
TouchContainer
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainer
  tetherSprite : Sprite
Hotspot
Public Methods
 MethodDefined By
  
Constructor
Hotspot
 Inherited
TouchContainer
 Inherited
method searches the child and adds to the list
TouchContainer
 Inherited
addChild(child:DisplayObject):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
applyLayout(value:* = null):void
Apply the containers layout
TouchContainer
 Inherited
childToList(id:String, child:*):void
child appended to the childlist
TouchContainer
 Inherited
clone():*
Clone method
TouchContainer
  
dispose():void
[override] Destructor
Hotspot
 Inherited
getElementById(id:String):*
Searches CML childList by id.
TouchContainer
 Inherited
getElementsByClassName(className:String):Array
Searches the CML childList by className.
TouchContainer
 Inherited
getElementsByTagName(tagName:Class):Array
Searches the CML childList by tagName as Class.
TouchContainer
  
init():void
[override] Initialisation method
Hotspot
 Inherited
loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number.
TouchContainer
 Inherited
makeGestureList(value:XMLList):Object
Creates gestureList object from XML
TouchContainer
 Inherited
parseCML(cml:XMLList):XMLList
Parse cml for local layouts.
TouchContainer
 Inherited
postparseCML(cml:XMLList):void
Abstract method allows the setting of a postparse CML routine.
TouchContainer
 Inherited
querySelector(selector:String):*
Searches the CML childList by selector.
TouchContainer
 Inherited
querySelectorAll(selector:*):Array
Search the CML childList by selector.
TouchContainer
 Inherited
removeChild(child:DisplayObject):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildAt(index:int):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void
[override] Removes children from display list and, if not already removed, the child list
TouchContainer
 Inherited
saveState(sId:* = null, recursion:Boolean = false):void
Save state by index number.
TouchContainer
 Inherited
searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists.
TouchContainer
 Inherited
method sets the dimensions of each child
TouchContainer
 Inherited
tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index.
TouchContainer
 Inherited
Updates child padding within this container
TouchContainer
 Inherited
Updates child percent dimensions within this container
TouchContainer
 Inherited
updateProperties(state:* = 0):void
Updates properties from state.
TouchContainer
 Inherited
Updates child relative positions within this container
TouchContainer
Protected Methods
 MethodDefined By
  
onEnterFrame(e:Event):void
Hotspot
  
Hotspot
Property Detail
compAbsPosproperty
public var compAbsPos:Boolean = false

compAddOnOpenproperty 
public var compAddOnOpen:Boolean = false

compCenterToStageproperty 
public var compCenterToStage:Boolean = false

componentproperty 
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.


Implementation
    public function get component():*
    public function set component(value:any):void
componentAnchorOffsetXproperty 
componentAnchorOffsetX:Number

X offset to where the tether sprite is anchored on the component


Implementation
    public function get componentAnchorOffsetX():Number
    public function set componentAnchorOffsetX(value:Number):void
componentAnchorOffsetYproperty 
componentAnchorOffsetY:Number

Y offset to where the tether sprite is anchored on the component


Implementation
    public function get componentAnchorOffsetY():Number
    public function set componentAnchorOffsetY(value:Number):void
compResetOnCloseproperty 
public var compResetOnClose:Boolean = false

compResetOnOpenproperty 
public var compResetOnOpen:Boolean = false

compTweenproperty 
public var compTween:Boolean = false

compTweenTimeproperty 
public var compTweenTime:Number = .25

compXproperty 
public var compX:Number = 0

compYproperty 
public var compY:Number = 0

sceneXproperty 
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).


Implementation
    public function get sceneX():Number
    public function set sceneX(value:Number):void
sceneYproperty 
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).


Implementation
    public function get sceneY():Number
    public function set sceneY(value:Number):void
tetherproperty 
tether:Boolean

Whether or not a tethering line will be drawn from the hotspot graphic to the component.


Implementation
    public function get tether():Boolean
    public function set tether(value:Boolean):void
tetherAlphaproperty 
tetherAlpha:Number

The alpha of the tethering line.


Implementation
    public function get tetherAlpha():Number
    public function set tetherAlpha(value:Number):void
tetherColorproperty 
tetherColor:uint

The color of the tethering line if set to true.


Implementation
    public function get tetherColor():uint
    public function set tetherColor(value:uint):void
tetherOffsetXproperty 
tetherOffsetX:Number

X offset to the source of the tether sprite


Implementation
    public function get tetherOffsetX():Number
    public function set tetherOffsetX(value:Number):void
tetherOffsetYproperty 
tetherOffsetY:Number

Y offset to the source of the tether sprite


Implementation
    public function get tetherOffsetY():Number
    public function set tetherOffsetY(value:Number):void
tetherSpriteproperty 
protected var tetherSprite:Sprite

tetherStrokeproperty 
tetherStroke:Number

The stroke of the tethering line.


Implementation
    public function get tetherStroke():Number
    public function set tetherStroke(value:Number):void
Constructor Detail
Hotspot()Constructor
public function Hotspot()

Constructor

Method Detail
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 
protected function onHotspot(e:StateEvent):void

Parameters

e:StateEvent