lc.procmgmt.ui.endpoint

# EndpointEvent - AS3 ADEP Document Services

(Beta)

Package | lc.procmgmt.ui.endpoint
Class | public class EndpointEvent
Inheritance | EndpointEvent Event Object

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10

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

The properties of the `Event` object have these values:

Property | Value
--- | ---
`endpoint` | The endpoint that was selected.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented. | Event
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | currentTarget : 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
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | target : Object [read-only] The event target. | Event
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | EndpointEvent(type:String, endpoint:Endpoint) Constructor. | EndpointEvent
|  | clone():Event [override] Creates a copy of an EndpointEvent object and sets the value of each property to match that of the original. | EndpointEvent
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns a string containing all the properties of the Event object. | Event
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | ADD_FAVORITE : String = "addFavorite" [static] A special value that specifies that an endpoint was added to the favorites list. | EndpointEvent
|  | DETAILS : String = "detailsSelect" [static] A special value that specifies that details about the endpoint were retrieved and viewed. | EndpointEvent
|  | ENDPOINT_FAILED : String = "endpointFailed" [static] A special value that specifies that invoking an endpoint failed. | EndpointEvent
|  | INVOKE : String = "invokeSelect" [static] A special value that specifies that an endpoint was invoked successfully. | EndpointEvent
|  | REMOVE_FAVORITE : String = "removeFavorite" [static] A special value that specifies that an endpoint removed from the favorites list. | EndpointEvent

Property Detail

### endpoint

property

`public var endpoint:Endpoint`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10

The endpoint to include in the event.

Constructor Detail

### EndpointEvent

()
Constructor

`public function EndpointEvent(type:String, endpoint:Endpoint)`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10

Constructor.

Parameters

| `type:String`
| `endpoint:Endpoint`

Method Detail

### clone

()
method

`override public function clone():Event`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10

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_FAVORITE

Constant

`public static const ADD_FAVORITE:String = "addFavorite"`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10

A special value that specifies that an endpoint was added to the favorites list.

### DETAILS

Constant

`public static const DETAILS:String = "detailsSelect"`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10

A special value that specifies that details about the endpoint were retrieved and viewed. event.

### ENDPOINT_FAILED

Constant

`public static const ENDPOINT_FAILED:String = "endpointFailed"`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10

A special value that specifies that invoking an endpoint failed.

### INVOKE

Constant

`public static const INVOKE:String = "invokeSelect"`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10

A special value that specifies that an endpoint was invoked successfully. event.

### REMOVE_FAVORITE

Constant

`public static const REMOVE_FAVORITE:String = "removeFavorite"`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10

A special value that specifies that an endpoint removed from the favorites list.

© 2013 Adobe Systems Incorporated. All rights reserved.
Mon Nov 18 2013, 11:47 AM -08:00