ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.mosaic.sparklib.optionMenu 

OptionMenuEvent  - AS3 ADEP Composite Application

Packagecom.adobe.mosaic.sparklib.optionMenu
Classpublic class OptionMenuEvent
InheritanceOptionMenuEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
Runtime Versions: Flash Player 10.1, AIR 2.0.2

The events generated by the OptionMenuButton class.

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  index : int
The index of the selected item when the event type is SELECT_ITEM.
OptionMenuEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
OptionMenuEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false)
Constructor.
OptionMenuEvent
 Inherited
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  CLOSE_ITEM : String = "closeItem"
[static] A special value that is dispatched when the Close item is selected from the menu.
OptionMenuEvent
  SAVE_AS_ITEM : String = "saveAsItem"
[static] A special value that is dispatched when the Save As item is selected from the menu.
OptionMenuEvent
  SAVE_ITEM : String = "saveItem"
[static] A special value that is dispatched when the Save item is selected from the menu.
OptionMenuEvent
  SELECT_ITEM : String = "selectItem"
[static] A special value that is dispatched when a item is selected from the menu.
OptionMenuEvent
  SHOW_LINK : String = "showLink"
[static] A special value that is dispatched when the Show Link item is selected from the menu.
OptionMenuEvent
Property Detail

index

property
public var index:int

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

The index of the selected item when the event type is SELECT_ITEM.

Constructor Detail

OptionMenuEvent

()Constructor
public function OptionMenuEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false)

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

Constructor.

Parameters
type:String — The event type; one of SELECT_ITEM, CLOSE_ITEM, or SAVE_ITEM.
 
bubbles:Boolean (default = true) — Indicates if the event should travel up the event chain.
 
cancelable:Boolean (default = false) — Indicates if the event can be cancelled.
Constant Detail

CLOSE_ITEM

Constant
public static const CLOSE_ITEM:String = "closeItem"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

A special value that is dispatched when the Close item is selected from the menu.

SAVE_AS_ITEM

Constant 
public static const SAVE_AS_ITEM:String = "saveAsItem"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

A special value that is dispatched when the Save As item is selected from the menu.

SAVE_ITEM

Constant 
public static const SAVE_ITEM:String = "saveItem"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

A special value that is dispatched when the Save item is selected from the menu.

SELECT_ITEM

Constant 
public static const SELECT_ITEM:String = "selectItem"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

A special value that is dispatched when a item is selected from the menu.

SHOW_LINK

Constant 
public static const SHOW_LINK:String = "showLink"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

A special value that is dispatched when the Show Link item is selected from the menu.