Packagelc.endpoint
Classpublic class EndpointEvent
InheritanceEndpointEvent Inheritance Event Inheritance Object

The EndpointEvent class contains events that are dispatched when a user performs an action against an endpoint.



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
  endpoint : Endpoint
The endpoint to include in the event.
EndpointEvent
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
EndpointEvent(type:String, endpoint:Endpoint)
Constructor.
EndpointEvent
  
Creates a copy of an EndpointEvent object and sets the value of each property to match that of the original.
EndpointEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in your custom Event class.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether preventDefault() 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 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
 InheritedACTIVATE : String = "activate"
[static] Defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] Defines the value of the type property of an added event object.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] Defines the value of the type property of an addedToStage event object.
Event
  ADD_FAVORITE : String = "addFavorite"
[static] The EndpointEvent.ADD_FAVORITE constant defines the value of the type property of the event object for a addFavorite event.
EndpointEvent
 InheritedCANCEL : String = "cancel"
[static] Defines the value of the type property of a cancel event object.
Event
 InheritedCHANGE : String = "change"
[static] Defines the value of the type property of a change event object.
Event
 InheritedCLOSE : String = "close"
[static] Defines the value of the type property of a close event object.
Event
 InheritedCOMPLETE : String = "complete"
[static] Defines the value of the type property of a complete event object.
Event
 InheritedCONNECT : String = "connect"
[static] Defines the value of the type property of a connect event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] Defines the value of the type property of a deactivate event object.
Event
  DETAILS : String = "detailsSelect"
[static] The EndpointEvent.DETAILS constant defines the value of the type property of the event object for a detailsSelect event.
EndpointEvent
  ENDPOINT_FAILED : String = "endpointFailed"
[static] The EndpointEvent.ENDPOINT_FAILED constant defines the value of the type property of the event object for a endpointFailed event.
EndpointEvent
 InheritedENTER_FRAME : String = "enterFrame"
[static] Defines the value of the type property of an enterFrame event object.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] Defines the value of the type property of a fullScreen event object.
Event
 InheritedID3 : String = "id3"
[static] Defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] Defines the value of the type property of an init event object.
Event
  INVOKE : String = "invokeSelect"
[static] The EndpointEvent.INVOKE constant defines the value of the type property of the event object for a invokeSelect event.
EndpointEvent
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] Defines the value of the type property of a mouseLeave event object.
Event
 InheritedOPEN : String = "open"
[static] Defines the value of the type property of an open event object.
Event
 InheritedREMOVED : String = "removed"
[static] Defines the value of the type property of a removed event object.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] Defines the value of the type property of a removedFromStage event object.
Event
  REMOVE_FAVORITE : String = "removeFavorite"
[static] The EndpointEvent.REMOVE_FAVORITE constant defines the value of the type property of the event object for a removeFavorite event.
EndpointEvent
 InheritedRENDER : String = "render"
[static] Defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] Defines the value of the type property of a resize event object.
Event
 InheritedSCROLL : String = "scroll"
[static] Defines the value of the type property of a scroll event object.
Event
 InheritedSELECT : String = "select"
[static] Defines the value of the type property of a select event object.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] Defines the value of the type property of a soundComplete event object.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] Defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] Defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] Defines the value of the type property of a tabIndexChange event object.
Event
 InheritedUNLOAD : String = "unload"
[static] Defines the value of the type property of an unload event object.
Event
Property Detail
endpointproperty
public var endpoint:Endpoint

The endpoint to include in the event.

Constructor Detail
EndpointEvent()Constructor
public function EndpointEvent(type:String, endpoint:Endpoint)

Constructor.

Parameters
type:String
 
endpoint:Endpoint
Method Detail
clone()method
public override function clone():Event

Creates a copy of an EndpointEvent object and sets the value of each property to match that of the original.

Returns
Event
Constant Detail
ADD_FAVORITEConstant
public static const ADD_FAVORITE:String = "addFavorite"

The EndpointEvent.ADD_FAVORITE constant defines the value of the type property of the event object for a addFavorite event. This event is set to always bubble.

The properties of the event object have the following values:

PropertyValue
endpointThe endpoint that was selected.

DETAILSConstant 
public static const DETAILS:String = "detailsSelect"

The EndpointEvent.DETAILS constant defines the value of the type property of the event object for a detailsSelect event. This event is set to always bubble.

The properties of the event object have the following values:

PropertyValue
endpointThe endpoint that was selected.

ENDPOINT_FAILEDConstant 
public static const ENDPOINT_FAILED:String = "endpointFailed"

The EndpointEvent.ENDPOINT_FAILED constant defines the value of the type property of the event object for a endpointFailed event. This event is set to always bubble.

The properties of the event object have the following values:

PropertyValue
endpointThe endpoint that was selected.

INVOKEConstant 
public static const INVOKE:String = "invokeSelect"

The EndpointEvent.INVOKE constant defines the value of the type property of the event object for a invokeSelect event. This event is set to always bubble.

The properties of the event object have the following values:

PropertyValue
endpointThe endpoint that was selected.

REMOVE_FAVORITEConstant 
public static const REMOVE_FAVORITE:String = "removeFavorite"

The EndpointEvent.REMOVE_FAVORITE constant defines the value of the type property of the event object for a removeFavorite event. This event is set to always bubble.

The properties of the event object have the following values:

PropertyValue
endpointThe endpoint that was selected.





 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/lc/endpoint/EndpointEvent.html