套件 | lc.procmgmt.domain |
類別 | public class QueueBase |
繼承 | QueueBase DomainObject Object |
實作 | IEventDispatcher |
子類別 | DraftQueue, InitialQueue, Queue |
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
QueueBase
class manages a collection of
Task
objects. This class should not be used
directly; its functionality is available through one of
its subclasses.
相關 API 元素
屬性 | 定義自 | ||
---|---|---|---|
constructor : Object
類別物件的參照或是特定物件實體的建構函數。 | Object | ||
isDefault : Boolean
A flag that indicates whether the queue is default. | QueueBase | ||
name : String
The name of the queue. | QueueBase | ||
session : SessionMap [唯讀]
A SessionMap object that stores information relating to the server session. | DomainObject | ||
taskCountAll : Number
The count of all tasks in the queue. | QueueBase | ||
tasks : ListCollectionView
The collection of tasks associated with this queue. | QueueBase | ||
type : Number
The type of the queue. | QueueBase |
方法 | 定義自 | ||
---|---|---|---|
Constructor. | QueueBase | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | QueueBase | ||
Adds a task to the queue. | QueueBase | ||
Dispatches an event into the event flow. | QueueBase | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | QueueBase | ||
指出物件是否有已定義的指定屬性。 | Object | ||
Determines whether the queue is a group queue. | QueueBase | ||
指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。 | Object | ||
Determines whether the queue is a shared queue. | QueueBase | ||
Determines whether the queue is the user's queue. | QueueBase | ||
指出指定的屬性是否存在,以及是否可列舉。 | Object | ||
Removes a listener from the EventDispatcher object. | QueueBase | ||
Removes a task from the queue. | QueueBase | ||
為迴圈作業設定動態屬性的可用性。 | Object | ||
傳回代表此物件的字串,根據地區特定慣例進行格式化。 | Object | ||
會傳回指定之物件的字串形式。 | Object | ||
會傳回指定之物件的基本值。 | Object | ||
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | QueueBase |
isDefault | 屬性 |
isDefault:Boolean
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A flag that indicates whether the queue is default.
預設值為 false。
此屬性可以做為資料繫結的來源。一旦修改此屬性,將傳送 propertyChange
事件。
實作
public function get isDefault():Boolean
public function set isDefault(value:Boolean):void
name | 屬性 |
name:String
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The name of the queue.
此屬性可以做為資料繫結的來源。一旦修改此屬性,將傳送 propertyChange
事件。
實作
public function get name():String
public function set name(value:String):void
taskCountAll | 屬性 |
taskCountAll:Number
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Document Services - Workspace 9.0.0.1 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The count of all tasks in the queue. tasks.length represents the filtered count of tasks.
此屬性可以做為資料繫結的來源。一旦修改此屬性,將傳送 propertyChange
事件。
實作
public function get taskCountAll():Number
public function set taskCountAll(value:Number):void
tasks | 屬性 |
tasks:ListCollectionView
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The collection of tasks associated with this queue.
此屬性可以做為資料繫結的來源。一旦修改此屬性,將傳送 propertyChange
事件。
實作
public function get tasks():ListCollectionView
public function set tasks(value:ListCollectionView):void
type | 屬性 |
type:Number
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The type of the queue. It may be one of the following values,
QueueConstants.USER, QueueConstants.GROUP, QueueConstants.SHARED
.
此屬性可以做為資料繫結的來源。一旦修改此屬性,將傳送 propertyChange
事件。
實作
public function get type():Number
public function set type(value:Number):void
相關 API 元素
QueueBase | () | 建構函式 |
public function QueueBase()
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Constructor.
addEventListener | () | 方法 |
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.
After you successfully register an event listener, you cannot change its priority
through additional calls to addEventListener()
. To change a listener's priority, you
must first call removeEventListener()
. Then you can register the listener again with the new
priority level.
After the listener is registered, subsequent calls to
addEventListener()
with a different value for either type
or useCapture
result in the
creation of a separate listener registration. For example, if you first register a
listener with useCapture
set to true
, it listens only during the capture phase. If you
call addEventListener()
again using the same listener object, but with useCapture
set to
false
, you have two separate listeners: one that listens during the capture phase, and
another that listens during the target and bubbling phases.
You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.
When you no longer need an event listener, remove it by calling EventDispatcher.removeEventListener()
; otherwise, memory problems might result. Objects
with registered event listeners are not automatically removed from memory because the
garbage collector does not remove objects that still have references.
Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.
If the event listener is being registered on a node while an event is also being processed on this node, the event listener is not triggered during the current phase but may be triggered during a later phase in the event flow, such as the bubbling phase.
If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless it is registered again for future processing).
參數
type:String — The type of event.
| |
listener:Function — The listener function that processes the event. This function must accept an event object
as its only parameter and must return nothing, as this example shows:
| |
useCapture:Boolean (default = false ) — Determines whether the listener works in the capture phase or the target
and bubbling phases. If useCapture is set to true , the
listener processes the event only during the capture phase and not in the target or
bubbling phase. If useCapture is false , the listener processes the event only
during the target or bubbling phase. To listen for the event in all three phases, call
addEventListener() twice, once with useCapture set to true ,
then again with useCapture set to false .
| |
priority:int (default = 0 ) — The priority level of the event listener. Priorities are designated by a 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.
| |
weakRef:Boolean (default = false ) — Determines whether the reference to the listener is strong or weak. A strong
reference (the default) prevents your listener from being garbage-collected. A weak
reference does not. Class-level member functions are not subject to garbage
collection, so you can set |
addTask | () | 方法 |
public function addTask(task:lc.procmgmt.domain:Task):void
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Adds a task to the queue.
參數
task:lc.procmgmt.domain:Task — Specifies the task to be added to the queue.
|
dispatchEvent | () | 方法 |
public function dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow. The event target is the
EventDispatcher object upon which dispatchEvent()
is called.
參數
event:Event — The event object dispatched into the event flow.
|
Boolean — A value of true unless preventDefault() is called on the event,
in which case it returns false .
|
hasEventListener | () | 方法 |
public function hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether
a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger()
.
The difference between hasEventListener()
and willTrigger()
is that hasEventListener()
examines only the object to which it belongs, whereas willTrigger()
examines the entire event flow for the event specified by the type
parameter.
參數
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type is registered; false otherwise.
|
isGroupQueue | () | 方法 |
public function isGroupQueue():Boolean
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Determines whether the queue is a group queue.
傳回值Boolean — Whether the queue is a group queue or user queue.
A value of true indicates that the queue is a group queue.
A value of false indicates that the queue is a user queue.
|
isSharedQueue | () | 方法 |
public function isSharedQueue():Boolean
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Determines whether the queue is a shared queue.
傳回值Boolean — A Boolean value that indicates whether the queue is shared.
A value of true indicates that the queue is shared.
A value of false indicates that the queue is not shared.
|
isUserQueue | () | 方法 |
public function isUserQueue():Boolean
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Determines whether the queue is the user's queue.
傳回值Boolean — A Boolean value that indicates whether the queue is the user's queue.
A value of true indicates that the queue is the user's queue.
A value of false indicates that the queue is not the user's queue.
|
removeEventListener | () | 方法 |
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.
參數
type:String — The type of event.
| |
listener:Function — The listener object to remove.
| |
useCapture:Boolean (default = false ) — Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to removeEventListener() are required to remove both: one call with useCapture set to true , and another call with useCapture set to false .
|
removeTask | () | 方法 |
public function removeTask(task:lc.procmgmt.domain:Task):lc.procmgmt.domain:Task
語言版本: | ActionScript 3.0 |
產品版本: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Removes a task from the queue.
參數
task:lc.procmgmt.domain:Task — Specifies the task to be removed from the queue.
|
lc.procmgmt.domain:Task — The task that was removed from the queue. If task as not in the queue, it returns null.
|
willTrigger | () | 方法 |
public function 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. This method returns true
if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.
The difference between hasEventListener()
and willTrigger()
is that hasEventListener()
examines only the object to which it belongs, whereas willTrigger()
examines the entire event flow for the event specified by the type
parameter.
參數
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.
|
Tue Jun 12 2018, 03:47 PM Z