用于 Adobe® Flash® Platform 的 ActionScript® 3.0 参考
主页  |  隐藏包列表和类列表 |   |   |  新增内容  |  索引  |  附录  |  为什么显示为英语?
过滤条件: 正在从服务器检索数据...
正在从服务器检索数据...
com.adobe.solutions.rca.domain.impl 

User  - AS3 Review, Commenting, and Approval

com.adobe.solutions.rca.domain.impl
public class User
继承User Inheritance Object
实现 IUser, IEventDispatcher

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10.0
运行时版本: Flash Player 10.2, AIR (unsupported)

This class defines an user.



公共属性
 属性由以下参数定义
  canonicalName : String
[只读] Canonical name for a user or a group, as defined in Document Server User Management.
User
  commonName : String
[只读] Common name of a user, as defined in Document Server User Management.
User
 Inheritedconstructor : Object
对类对象或给定对象实例的构造函数的引用。
Object
  description : String
[只读] Description for a user.
User
  domainCommonName : String
[只读] Domain common name for a user.
User
  domainName : String
[只读] Domain name for a user.
User
  email : String
[只读] Email address of a user.
User
  familyName : String
[只读] Family name of a user.
User
  givenName : String
[只读] Given name of a user.
User
  initials : String
[只读] Initials of a user.
User
  oid : String
[只读] OID of a user or a group, as defined in Document Server User Management.
User
  org : String
[只读] Organisation name of a user.
User
  principalName : String
The principal name of a user.
User
  principalType : String
[只读] Principal type of a user, as defined in Document Server User Management.
User
  status : String
[只读] Status of a user.
User
  type : String
[只读] Type of a user.
User
  userid : String
[只读] Unique identifier of a user.
User
  userManager : IUserManager
User manager service instance for a user.
User
  vo : PrincipalVO
The value object for this user.
User
公共方法
 方法由以下参数定义
  
User(principalName:String = null)
The constructor for User class.
User
  
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.
User
  
Dispatches an event into the event flow.
User
  
Gets the principal for this tuple of domain name and canonical name.
User
  
Gets the principal for this principal name.
User
  
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
User
 Inherited
表示对象是否已经定义了指定的属性。
Object
 Inherited
表示 Object 类的实例是否在指定为参数的对象的原型链中。
Object
 Inherited
表示指定的属性是否存在、是否可枚举。
Object
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
User
 Inherited
设置循环操作动态属性的可用性。
Object
 Inherited
返回此对象的字符串表示形式,其格式设置遵守区域设置特定的约定。
Object
 Inherited
返回指定对象的字符串表示形式。
Object
 Inherited
返回指定对象的原始值。
Object
  
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
User
属性详细信息

canonicalName

属性
canonicalName:String  [只读]

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10
运行时版本: Flash Player 10.2, AIR (unsupported)

Canonical name for a user or a group, as defined in Document Server User Management.



实现
    public function get canonicalName():String

commonName

属性 
commonName:String  [只读]

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10
运行时版本: Flash Player 10.2, AIR (unsupported)

Common name of a user, as defined in Document Server User Management.



实现
    public function get commonName():String

description

属性 
description:String  [只读]

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10
运行时版本: Flash Player 10.2, AIR (unsupported)

Description for a user.



实现
    public function get description():String

domainCommonName

属性 
domainCommonName:String  [只读]

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10
运行时版本: Flash Player 10.2, AIR (unsupported)

Domain common name for a user.



实现
    public function get domainCommonName():String

domainName

属性 
domainName:String  [只读]

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10
运行时版本: Flash Player 10.2, AIR (unsupported)

Domain name for a user.



实现
    public function get domainName():String

email

属性 
email:String  [只读]

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10
运行时版本: Flash Player 10.2, AIR (unsupported)

Email address of a user.



实现
    public function get email():String

familyName

属性 
familyName:String  [只读]

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10
运行时版本: Flash Player 10.2, AIR (unsupported)

Family name of a user.



实现
    public function get familyName():String

givenName

属性 
givenName:String  [只读]

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10
运行时版本: Flash Player 10.2, AIR (unsupported)

Given name of a user.



实现
    public function get givenName():String

initials

属性 
initials:String  [只读]

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10
运行时版本: Flash Player 10.2, AIR (unsupported)

Initials of a user.



实现
    public function get initials():String

oid

属性 
oid:String  [只读]

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10
运行时版本: Flash Player 10.2, AIR (unsupported)

OID of a user or a group, as defined in Document Server User Management.



实现
    public function get oid():String

org

属性 
org:String  [只读]

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10
运行时版本: Flash Player 10.2, AIR (unsupported)

Organisation name of a user.



实现
    public function get org():String

principalName

属性 
principalName:String

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10
运行时版本: Flash Player 10.2, AIR (unsupported)

The principal name of a user.



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

principalType

属性 
principalType:String  [只读]

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10
运行时版本: Flash Player 10.2, AIR (unsupported)

Principal type of a user, as defined in Document Server User Management.



实现
    public function get principalType():String

status

属性 
status:String  [只读]

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10
运行时版本: Flash Player 10.2, AIR (unsupported)

Status of a user.



实现
    public function get status():String

type

属性 
type:String  [只读]

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10
运行时版本: Flash Player 10.2, AIR (unsupported)

Type of a user.



实现
    public function get type():String

userid

属性 
userid:String  [只读]

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10
运行时版本: Flash Player 10.2, AIR (unsupported)

Unique identifier of a user.



实现
    public function get userid():String

userManager

属性 
userManager:IUserManager

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10
运行时版本: Flash Player 10.2, AIR (unsupported)

User manager service instance for a user.



实现
    public function get userManager():IUserManager
    public function set userManager(value:IUserManager):void

vo

属性 
vo:PrincipalVO

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10
运行时版本: Flash Player 10.2, AIR (unsupported)

The value object for this user.



实现
    public function get vo():PrincipalVO
    public function set vo(value:PrincipalVO):void
构造函数详细信息

User

()构造函数
public function User(principalName:String = null)

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10.0
运行时版本: Flash Player 10.2, AIR (unsupported)

The constructor for User class.

参数
principalName:String (default = null) — User's principal name.
方法详细信息

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.

getPrincipalByDomainNameCanonicalName

()方法 
public function getPrincipalByDomainNameCanonicalName(domainName:String, canonicalName:String):void

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10
运行时版本: Flash Player 10.2, AIR (unsupported)

Gets the principal for this tuple of domain name and canonical name.

参数

domainName:String — Domain name of the principal in Document Server User Management.
 
canonicalName:String — Canonical name of the principal in Document Server User Management.

getPrincipalByPrincipalName

()方法 
public function getPrincipalByPrincipalName(principalName:String):void

语言版本: ActionScript 3.0
产品版本: Review, Commenting, and Approval Building Block 10
运行时版本: Flash Player 10.2, AIR (unsupported)

Gets the principal for this principal name.

参数

principalName:String — Principal name of a user.

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.

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.




[ X ]为什么显示为英语?
《ActionScript 3.0 参考》中的内容以英语显示

《ActionScript 3.0 参考》中的部分内容未翻译成所有语言。当某个语言元素未翻译时,将显示为英语。例如,ga.controls.HelpBox 类未翻译成任何语言。因此在简体中文版的参考中,ga.controls.HelpBox 类显示为英语。