Packagesoi.events
Classpublic class HotSpotEvent
InheritanceHotSpotEvent Inheritance flash.events.Event

The HotSpotEvent class represents event objects that are dispatched to change, clear and place the HotSpot control


Public Properties
 PropertyDefined by
  properties : Object
The properties object acts as a flexible transport object to allow complex data to be attached to the event object during dispatch at run time.
HotSpotEvent
Public Methods
 MethodDefined by
  
HotSpotEvent(type:String = null, bubbles:Boolean = true, properties:Object = null)
Constructor.
HotSpotEvent
Public Constants
 ConstantDefined by
  HOTSPOT_CHANGE : String = "HotSpotChange"
[static] The HotSpotEvent.HOTSPOT_CHANGE constant defines the value of the type property of the event object for a HotSpotChange event.
HotSpotEvent
  HOTSPOT_CLEAR : String = "HotSpotClear"
[static] The >HotSpotEvent.HOTSPOT_CLEAR constant defines the value of the type property of the event object for a HotSpotClear event.
HotSpotEvent
  HOTSPOT_PLACE : String = "HotSpotPlace"
[static] The >HotSpotEvent.HOTSPOT_PLACE constant defines the value of the type property of the event object for a HotSpotPlace event.
HotSpotEvent
Property detail
propertiesproperty
public var properties:Object

The properties object acts as a flexible transport object to allow complex data to be attached to the event object during dispatch at run time.

Constructor detail
HotSpotEvent()constructor
public function HotSpotEvent(type:String = null, bubbles:Boolean = true, properties:Object = null)

Constructor. Typically instantiated inline within the dispatchEvent method.

Parameters
type:String (default = null) — The event type; indicates the action that caused the event.
 
bubbles:Boolean (default = true) — Specifies whether the event can bubble up the display list hierarchy.
 
properties:Object (default = null) — A transport object to allow complex data to be attached to the event object during dispatch.
Constant detail
HOTSPOT_CHANGEconstant
public static const HOTSPOT_CHANGE:String = "HotSpotChange"

The HotSpotEvent.HOTSPOT_CHANGE constant defines the value of the type property of the event object for a HotSpotChange event. The remaining properties of the event object are the bubbles boolean to allow the event to bubble up the display list to the Application class, and the properties object for attaching a user defined transport object to the event at run time. The HotSpotChange event uses the properties object to transport the new x, y, w, and h values of a hotspot as object literals.

HOTSPOT_CLEARconstant 
public static const HOTSPOT_CLEAR:String = "HotSpotClear"

The >HotSpotEvent.HOTSPOT_CLEAR constant defines the value of the type property of the event object for a HotSpotClear event. The HotSpotClear event is dispatched for processing by the Application class - which responds to this event by setting the x, y, w, and h attributes of the currently selected link to an empty string, effectively removing the hotspot. The HotSpotClear event object requires no additional parametres as the bubbles boolean defaults to true to allow the event to bubble up the display list to the Application class.

HOTSPOT_PLACEconstant 
public static const HOTSPOT_PLACE:String = "HotSpotPlace"

The >HotSpotEvent.HOTSPOT_PLACE constant defines the value of the type property of the event object for a HotSpotPlace event. The HotSpotPlace event is dispatched when the x, y, w, and/or h attributes of the currently selected link are empty and is processed by the Application class - which responds to this event by setting the x, y, w, and h attributes of the currently selected link to the default start dimensions of a hotspot. The Application class then instantiates a hotspot control with these new values and adds it to the display list for interaction. The HotSpotPlace event object requires no additional parametres as the bubbles boolean defaults to true to allow the event to bubble up the display list to the Application class.