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

LabelEditorEvent  - AS3 ADEP Composite Application

Packagecom.adobe.mosaic.sparklib.editors
Classpublic class LabelEditorEvent
InheritanceLabelEditorEvent Inheritance Event Inheritance Object

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 LabelEditorEvent is dispatched by the LabelEditor when the change should be committed (saved) or cancelled (discarded).

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
  newLabel : String
The new label for the tab, as entered by the user.
LabelEditorEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
LabelEditorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)
Constructor.
LabelEditorEvent
 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
  CANCEL : String = "cancel"
[static] A special value that specifies that the CANCEL event is dispatched when the user presses the ESCAPE key or when the user clicks the mouse outside of the LabelEditor boundary.
LabelEditorEvent
  COMMIT : String = "commit"
[static] A special value that specifies that the COMMIT event is dispatched when the user presses the ENTER key.
LabelEditorEvent
Property Detail

newLabel

property
public var newLabel:String

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 new label for the tab, as entered by the user.

Constructor Detail

LabelEditorEvent

()Constructor
public function LabelEditorEvent(type:String, bubbles:Boolean = false, 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 — Either COMMIT or CANCEL
 
bubbles:Boolean (default = false) — Whether or not the evnet travels up the event chain.
 
cancelable:Boolean (default = false) — Whether or not the event can be cancelled.
Constant Detail

CANCEL

Constant
public static const CANCEL:String = "cancel"

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 specifies that the CANCEL event is dispatched when the user presses the ESCAPE key or when the user clicks the mouse outside of the LabelEditor boundary.

COMMIT

Constant 
public static const COMMIT:String = "commit"

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 specifies that the COMMIT event is dispatched when the user presses the ENTER key.