lc.procmgmt.ui.endpoint

# EndpointGridSelectorModel - AS3 ADEP Document Services

(Beta)

Package | lc.procmgmt.ui.endpoint
Class | public class EndpointGridSelectorModel
Inheritance | EndpointGridSelectorModel PresentationModel EventDispatcher 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 `EndpointGridSelectorModel` class acts as the presentation model for the `EndpointGridSelector` component.

Related API Elements

lc.procmgmt.ui.endpoint.EndpointGridSelector

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | endpoint : Endpoint [read-only] The currently selected endpoint. | EndpointGridSelectorModel
|  | endpoints : ListCollectionView A collection of endpoints. | EndpointGridSelectorModel
|  | hotCharCode : uint [read-only] The key code for the Enter hot key. | EndpointGridSelectorModel
|  | session : SessionMap A SessionMap object that stores information relating to the server session. | PresentationModel
|  | state : String [read-only] The name of the state the current view is in. | PresentationModel

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. | EventDispatcher
|  | bindProperty(destination:Object, destinationProperty:String, source:Object, sourceChain:Object, commitOnly:Boolean = false):ChangeWatcher Binds a public property on the destination object from a property or property chain on the source object. | PresentationModel
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | EventDispatcher
|  | getCSSStyle(declaration:String, styleProperty:String, defaultValue:Object = null):Object Returns the corresponding cascading style sheet (CSS) property to use based on the specified parameters. | PresentationModel
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | EventDispatcher
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | hotKey(charCode:uint):void Invokes the selected endpoint when the hot key is detected. | EndpointGridSelectorModel
|  | initialize():void Initializes the presentation model after the view bindings are processed to prevent view bindings from overriding the initial model state. | PresentationModel
|  | invokeSelectedEndpoint(endpoint:Object):void Invokes an endpoint to start a process. | EndpointGridSelectorModel
|  | 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
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | EventDispatcher
|  | setEndpoint(endpoint:Object):void Sets the currently selected endpoint. | EndpointGridSelectorModel
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object
|  | willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | EventDispatcher

Protected Methods
Hide Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | setState(newState:String):void Sets the state property to a new value and causes a PropertyChangeEvent event. | PresentationModel

Events
Click for more information on events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | activate | [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher
|  | deactivate | [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher
|  | invokeSelect | Dispatched to invoke an endpoint. | EndpointGridSelectorModel

Property Detail

### endpoint

property

`endpoint:Endpoint` [read-only]

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 currently selected endpoint.

This property can be used as the source for data binding. When this property is modified, it dispatches the `propertyChange` event.

Implementation
`public function get endpoint():Endpoint`

### endpoints

property

`endpoints:ListCollectionView`

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 collection of endpoints.

Implementation
`public function get endpoints():ListCollectionView`
`public function set endpoints(value:ListCollectionView):void`

### hotCharCode

property

`hotCharCode:uint` [read-only]

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 key code for the Enter hot key.

This property can be used as the source for data binding. When this property is modified, it dispatches the `propertyChange` event.

Implementation
`public function get hotCharCode():uint`
Method Detail

### hotKey

()
method

`public function hotKey(charCode:uint):void`

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

Invokes the selected endpoint when the hot key is detected.

Parameters

| `charCode:uint` — Specifies the character code for the user keystroke.

### invokeSelectedEndpoint

()
method

`public function invokeSelectedEndpoint(endpoint:Object):void`

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

Invokes an endpoint to start a process.

Parameters

| `endpoint:Object` — Specifies the endpoint to be invoked.

### setEndpoint

()
method

`public function setEndpoint(endpoint:Object):void`

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

Sets the currently selected endpoint.

Parameters

| `endpoint:Object` — Specifies the endpoint to be selected.

Event Detail

### invokeSelect

Event

Event Object Type: `lc.procmgmt.ui.endpoint.EndpointEvent`
property EndpointEvent.type = `lc.procmgmt.ui.endpoint.EndpointEvent`

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

Dispatched to invoke an endpoint. Invoking an endpoint has the effect of starting a process.

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