QueueBase

Paket	lc.procmgmt.domain
Klasse	public class QueueBase
Vererbung	QueueBase DomainObject Object
Implementiert	IEventDispatcher
Unterklassen	DraftQueue, InitialQueue, Queue

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

The QueueBase class manages a collection of Task objects. This class should not be used directly; its functionality is available through one of its subclasses.

Verwandte API-Elemente

lc.procmgmt.domain.Queue
lc.procmgmt.domain.InitialQueue
lc.procmgmt.domain.DraftQueue

Öffentliche Eigenschaften

Vererbte öffentliche Eigenschaften ausblenden

Vererbte öffentliche Eigenschaften anzeigen

	Eigenschaft		Definiert von
		constructor : Object Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.	Object
		isDefault : Boolean A flag that indicates whether the queue is default.	QueueBase
		name : String The name of the queue.	QueueBase
		session : SessionMap [schreibgeschützt] 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

Öffentliche Methoden

Vererbte öffentliche Methoden ausblenden

Vererbte öffentliche Methoden anzeigen

	Methode		Definiert von
		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
		addTask(task:lc.procmgmt.domain:Task):void Adds a task to the queue.	QueueBase
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	QueueBase
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	QueueBase
		hasOwnProperty(name:String):Boolean Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.	Object
		isGroupQueue():Boolean Determines whether the queue is a group queue.	QueueBase
		isPrototypeOf(theClass:Object):Boolean Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.	Object
		isSharedQueue():Boolean Determines whether the queue is a shared queue.	QueueBase
		isUserQueue():Boolean Determines whether the queue is the user's queue.	QueueBase
		propertyIsEnumerable(name:String):Boolean Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	QueueBase
		removeTask(task:lc.procmgmt.domain:Task):lc.procmgmt.domain:Task Removes a task from the queue.	QueueBase
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.	Object
		toLocaleString():String Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.	Object
		toString():String Gibt das angegebene Objekt als String zurück.	Object
		valueOf():Object Gibt den Grundwert des angegebenen Objekts zurück.	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.	QueueBase

Eigenschaftendetails

isDefault

Eigenschaft

isDefault:Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

A flag that indicates whether the queue is default.

Der Standardwert ist false.

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das propertyChange -Ereignis ausgelöst.

Implementierung
public function get isDefault():Boolean
public function set isDefault(value:Boolean):void

name

Eigenschaft

name:String

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

The name of the queue.

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das propertyChange -Ereignis ausgelöst.

Implementierung
public function get name():String
public function set name(value:String):void

taskCountAll

Eigenschaft

taskCountAll:Number

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9.0.0.1

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

The count of all tasks in the queue. tasks.length represents the filtered count of tasks.

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das propertyChange -Ereignis ausgelöst.

Implementierung
public function get taskCountAll():Number
public function set taskCountAll(value:Number):void

tasks

Eigenschaft

tasks:ListCollectionView

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

The collection of tasks associated with this queue.

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das propertyChange -Ereignis ausgelöst.

Implementierung
public function get tasks():ListCollectionView
public function set tasks(value:ListCollectionView):void

type

Eigenschaft

type:Number

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

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.

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das propertyChange -Ereignis ausgelöst.

Implementierung
public function get type():Number
public function set type(value:Number):void

Verwandte API-Elemente

lc.procmgmt.QueueConstants

Konstruktordetails

()

Konstruktor

public function QueueBase()

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

Constructor.

Methodendetails

addEventListener

()

Methode

 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).

Parameter

	`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: `function(evt:Event):void` The function can have any name.

	`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 `useWeakReference` to `true` for class-level member functions without subjecting them to garbage collection. If you set `useWeakReference` to `true` for a listener that is a nested inner function, the function will be garbge-collected and no longer persistent. If you create references to the inner function (save it in another variable) then it is not garbage-collected and stays persistent.

addTask

()

Methode

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

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

Adds a task to the queue.

Parameter

task:lc.procmgmt.domain:Task — Specifies the task to be added to the queue.

dispatchEvent

()

Methode

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.

Parameter

event:Event — The event object dispatched into the event flow.

Rückgabewerte

Boolean — A value of true unless preventDefault() is called on the event, in which case it returns false.

hasEventListener

()

Methode

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.

Parameter

type:String — The type of event.

Rückgabewerte

Boolean — A value of true if a listener of the specified type is registered; false otherwise.

isGroupQueue

()

Methode

public function isGroupQueue():Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

Determines whether the queue is a group queue.

Rückgabewerte

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

()

Methode

public function isSharedQueue():Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

Determines whether the queue is a shared queue.

Rückgabewerte

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

()

Methode

public function isUserQueue():Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

Determines whether the queue is the user's queue.

Rückgabewerte

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

()

Methode

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.

Parameter

	`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

()

Methode

public function removeTask(task:lc.procmgmt.domain:Task):lc.procmgmt.domain:Task

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

Removes a task from the queue.

Parameter

task:lc.procmgmt.domain:Task — Specifies the task to be removed from the queue.

Rückgabewerte

lc.procmgmt.domain:Task — The task that was removed from the queue. If task as not in the queue, it returns null.

willTrigger

()

Methode

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.

Parameter

type:String — The type of event.

Rückgabewerte

Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.

Rechtliche Hinweise | Onlinedatenschutzerklärung

QueueBase - AS3 ADEP Workspace

Klassen x

isDefault

name

taskCountAll

tasks

type

QueueBase

addEventListener

addTask

dispatchEvent

hasEventListener

isGroupQueue

isSharedQueue

isUserQueue

removeEventListener

removeTask

willTrigger