ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
lc.procmgmt.ui.search 

SearchSelectorModel  - AS3 ADEP Workspace
Packagelc.procmgmt.ui.search
Classpublic class SearchSelectorModel
InheritanceSearchSelectorModel Inheritance PresentationModel Inheritance EventDispatcher Inheritance Object

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The SearchSelectorModel class provides support for the SearchSelector component.


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  searchTemplateDescriptor : lc.procmgmt.domain:SearchTemplateDescriptor
[read-only] The search template descriptor.
SearchSelectorModel
 Inheritedsession : SessionMap
A SessionMap object that stores information relating to the server session.
PresentationModel
 Inheritedstate : String
[read-only] The name of the state the current view is in.
PresentationModel
Public Methods
 MethodDefined By
  
SearchSelectorModel()
Constructor.
SearchSelectorModel
 Inherited
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
 Inherited
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
  
closeQuery():void
Closes a query.
SearchSelectorModel
  
closeResults():void
An event listener that handles when the result page closes.
SearchSelectorModel
  
closeTaskDetails():void
An event listener that handles when the task details page closes.
SearchSelectorModel
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
 Inherited
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
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
initialize():void
Initializes the presentation model after the view bindings are processed to prevent view bindings from overriding the initial model state.
PresentationModel
 Inherited
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
  
openDetails(task:lc.procmgmt.domain:Task):void
Opens details page for the given task.
SearchSelectorModel
  
openQuery(searchTemplateDescriptor:lc.procmgmt.domain:SearchTemplateDescriptor):void
Opens a query for the given search template descriptor.
SearchSelectorModel
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
  
setCommand(command:lc.procmgmt.commands:TaskCommand):void
Opens the details page to the User Directives tab for the given task.
SearchSelectorModel
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
  
taskDetailsCancel(value:Object):void
An event listener for the SearchTemplateEvent.SEARCH_CANCELLED event.
SearchSelectorModel
  
taskDetailsClose():void
An event listener that handles when the task details close.
SearchSelectorModel
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
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
 MethodDefined By
 Inherited
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
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
Public Constants
 ConstantDefined By
  STATE_LIST_SELECTOR : String = "listSelectorState"
[static] The model is set to this state when a user can select from a list.
SearchSelectorModel
  STATE_QUERY : String = "queryState"
[static] The model is set to this state when a user can perform a query.
SearchSelectorModel
  STATE_RESULTS : String = "resultsState"
[static] The model is set to this state when a user can display the search results.
SearchSelectorModel
  STATE_TASK_DETAILS : String = "detailsSelectorState"
[static] The model is set to this state when a user can show the details of a task.
SearchSelectorModel
Property Detail

searchTemplateDescriptor

property
searchTemplateDescriptor:lc.procmgmt.domain:SearchTemplateDescriptor  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The search template descriptor.

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 searchTemplateDescriptor():lc.procmgmt.domain:SearchTemplateDescriptor

Related API Elements

lc.procmgmt.domain.SearchTemplateDescriptor
Constructor Detail

SearchSelectorModel

()Constructor
public function SearchSelectorModel()

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Constructor.

Method Detail

closeQuery

()method
public function closeQuery():void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Closes a query.

closeResults

()method 
public function closeResults():void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

An event listener that handles when the result page closes.

closeTaskDetails

()method 
public function closeTaskDetails():void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

An event listener that handles when the task details page closes.

openDetails

()method 
public function openDetails(task:lc.procmgmt.domain:Task):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Opens details page for the given task.

Parameters

task:lc.procmgmt.domain:Task — The task to be opened for displaying its details.

openQuery

()method 
public function openQuery(searchTemplateDescriptor:lc.procmgmt.domain:SearchTemplateDescriptor):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Opens a query for the given search template descriptor.

Parameters

searchTemplateDescriptor:lc.procmgmt.domain:SearchTemplateDescriptor — The SearchTemplateDescriptor to be opened for query.

setCommand

()method 
public function setCommand(command:lc.procmgmt.commands:TaskCommand):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Opens the details page to the User Directives tab for the given task.

Parameters

command:lc.procmgmt.commands:TaskCommand — The TaskCommand object that contains the task ID and the command for displaying in task details.

taskDetailsCancel

()method 
public function taskDetailsCancel(value:Object):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

An event listener for the SearchTemplateEvent.SEARCH_CANCELLED event.

Parameters

value:Object — A value of the Object type, which can be a value of null.

taskDetailsClose

()method 
public function taskDetailsClose():void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

An event listener that handles when the task details close.

Constant Detail

STATE_LIST_SELECTOR

Constant
public static const STATE_LIST_SELECTOR:String = "listSelectorState"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The model is set to this state when a user can select from a list.

STATE_QUERY

Constant 
public static const STATE_QUERY:String = "queryState"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The model is set to this state when a user can perform a query.

STATE_RESULTS

Constant 
public static const STATE_RESULTS:String = "resultsState"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The model is set to this state when a user can display the search results.

STATE_TASK_DETAILS

Constant 
public static const STATE_TASK_DETAILS:String = "detailsSelectorState"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The model is set to this state when a user can show the details of a task.




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy