Principal - Adobe ActionScript® 3 (AS3 ADEP Workspace) API 参考

包	lc.foundation.domain
类	public class Principal
继承	Principal DomainObject Object
实现	IManaged
子类	Group, User

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Workspace 10

运行时版本:

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

The Principal class is base class for both the User and Group classes and contains a set of common attributes.

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		canonicalName : String The user's canonical name.	Principal
		commonName : String The user's common (display) name.	Principal
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		description : String A description of the user.	Principal
		directGroupMemberships : ArrayCollection The groups to which a user directly belongs.	Principal
		domainCommonName : String The user's common domain main.	Principal
		domainName : String The user directory's domain name for which the user is defined.	Principal
		email : String The email address of the user.	Principal
		emailAliases : Array The email aliases for the user.	Principal
		groupMemberships : ArrayCollection All groups to which a user belongs.	Principal
		local : Boolean The user's local value.	Principal
		locked : Boolean Specifies whether the user is locked.	Principal
		oid : String The unique identifier for the user called a object identifier.	Principal
		org : String The user's organization name.	Principal
		principalType : String The user's common domain main.	Principal
		roleMembership : ArrayCollection The roles to which a user belongs.	Principal
		session : SessionMap [只读] A SessionMap object that stores information relating to the server session.	DomainObject
		status : String The user's common domain main.	Principal
		system : Boolean A flag value that specifies whether the principal is a system principal.	Principal
		visibility : Number The user's visibility value.	Principal

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		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.	Principal
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	Principal
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	Principal
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	Principal
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回指定对象的字符串表示形式。	Object
		valueOf():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.	Principal

属性详细信息

canonicalName

属性

canonicalName:String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Workspace 10

运行时版本:

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

The user's canonical name. This string is unique within the scope of the domain.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get canonicalName():String
public function set canonicalName(value:String):void

commonName

属性

commonName:String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Workspace 10

运行时版本:

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

The user's common (display) name.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get commonName():String
public function set commonName(value:String):void

description

属性

description:String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Workspace 10

运行时版本:

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

A description of the user.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get description():String
public function set description(value:String):void

directGroupMemberships

属性

directGroupMemberships:ArrayCollection

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Workspace 10

运行时版本:

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

The groups to which a user directly belongs. The returned ArrayCollection object contains Group objects.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get directGroupMemberships():ArrayCollection
public function set directGroupMemberships(value:ArrayCollection):void

domainCommonName

属性

domainCommonName:String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Workspace 10

运行时版本:

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

The user's common domain main.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get domainCommonName():String
public function set domainCommonName(value:String):void

domainName

属性

domainName:String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Workspace 10

运行时版本:

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

The user directory's domain name for which the user is defined.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get domainName():String
public function set domainName(value:String):void

email

属性

email:String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Workspace 10

运行时版本:

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

The email address of the user.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get email():String
public function set email(value:String):void

emailAliases

属性

emailAliases:Array

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Workspace 10

运行时版本:

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

The email aliases for the user. The email aliases are in addition to the main email address specified by the email property.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get emailAliases():Array
public function set emailAliases(value:Array):void

groupMemberships

属性

groupMemberships:ArrayCollection

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Workspace 10

运行时版本:

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

All groups to which a user belongs. The returned ArrayCollection object contains Group objects.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get groupMemberships():ArrayCollection
public function set groupMemberships(value:ArrayCollection):void

local

属性

local:Boolean

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Workspace 10

运行时版本:

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

The user's local value.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get local():Boolean
public function set local(value:Boolean):void

locked

属性

locked:Boolean

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Workspace 10

运行时版本:

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

Specifies whether the user is locked. A locked principal cannot log onto the Document Server and requires an administrator to unlock it. A value of True specifies that the user is locked.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get locked():Boolean
public function set locked(value:Boolean):void

oid

属性

oid:String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Workspace 10

运行时版本:

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

The unique identifier for the user called a object identifier.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get oid():String
public function set oid(value:String):void

org

属性

org:String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Workspace 10

运行时版本:

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

The user's organization name.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get org():String
public function set org(value:String):void

principalType

属性

principalType:String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Workspace 10

运行时版本:

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

The user's common domain main.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get principalType():String
public function set principalType(value:String):void

roleMembership

属性

roleMembership:ArrayCollection

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Workspace 10

运行时版本:

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

The roles to which a user belongs. The roles returned are either directly assigned or inherited by the principal from its ancestors. The returned ArrayCollection object contains String objects.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get roleMembership():ArrayCollection
public function set roleMembership(value:ArrayCollection):void

status

属性

status:String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Workspace 10

运行时版本:

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

The user's common domain main.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get status():String
public function set status(value:String):void

system

属性

system:Boolean

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Workspace 10

运行时版本:

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

A flag value that specifies whether the principal is a system principal.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get system():Boolean
public function set system(value:Boolean):void

visibility

属性

visibility:Number

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Workspace 10

运行时版本:

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

The user's visibility value. The visibility level of the principal, indicates whether the principal can be shown in the user interface, or whether it qualifies for searches.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get visibility():Number
public function set visibility(value:Number):void

方法详细信息

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: `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.

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.

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

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.

参数

type:String — The type of event.

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

法律声明 | 在线隐私策略

Principal - AS3 ADEP Workspace

类 x

canonicalName

commonName

description

directGroupMemberships

domainCommonName

domainName

email

emailAliases

groupMemberships

local

locked

oid

org

principalType

roleMembership

status

system

visibility

addEventListener

dispatchEvent

hasEventListener

removeEventListener

willTrigger