Pacote | lc.foundation.domain |
Classe | public class Principal |
Herança | Principal DomainObject Object |
Implementações | IManaged |
Subclasses | Group, User |
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Principal
class is base class for both the User and Group classes and contains a set of common attributes.
Propriedade | Definido por | ||
---|---|---|---|
canonicalName : String
The user's canonical name. | Principal | ||
commonName : String
The user's common (display) name. | Principal | ||
constructor : Object
Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto. | 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 [somente leitura]
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 |
Método | Definido por | ||
---|---|---|---|
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 | ||
Dispatches an event into the event flow. | Principal | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | Principal | ||
Indica se um objeto tem uma propriedade especificada definida. | Object | ||
Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro. | Object | ||
Indica se a propriedade especificada existe e é enumerável. | Object | ||
Removes a listener from the EventDispatcher object. | Principal | ||
Define a disponibilidade de uma propriedade dinâmica para operações de repetição. | Object | ||
Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade. | Object | ||
Retorna a representação de string do objeto especificado. | Object | ||
Retorna o valor primitivo do objeto especificado. | Object | ||
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | Principal |
canonicalName | propriedade |
canonicalName:String
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The user's canonical name. This string is unique within the scope of the domain.
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange
.
Implementação
public function get canonicalName():String
public function set canonicalName(value:String):void
commonName | propriedade |
commonName:String
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The user's common (display) name.
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange
.
Implementação
public function get commonName():String
public function set commonName(value:String):void
description | propriedade |
description:String
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A description of the user.
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange
.
Implementação
public function get description():String
public function set description(value:String):void
directGroupMemberships | propriedade |
directGroupMemberships:ArrayCollection
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The groups to which a user directly belongs.
The returned ArrayCollection
object contains Group objects.
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange
.
Implementação
public function get directGroupMemberships():ArrayCollection
public function set directGroupMemberships(value:ArrayCollection):void
Elementos da API relacionados
domainCommonName | propriedade |
domainCommonName:String
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The user's common domain main.
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange
.
Implementação
public function get domainCommonName():String
public function set domainCommonName(value:String):void
domainName | propriedade |
domainName:String
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The user directory's domain name for which the user is defined.
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange
.
Implementação
public function get domainName():String
public function set domainName(value:String):void
propriedade |
email:String
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The email address of the user.
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange
.
Implementação
public function get email():String
public function set email(value:String):void
emailAliases | propriedade |
emailAliases:Array
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
Versões de runtime: | 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.
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange
.
Implementação
public function get emailAliases():Array
public function set emailAliases(value:Array):void
groupMemberships | propriedade |
groupMemberships:ArrayCollection
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
All groups to which a user belongs.
The returned ArrayCollection
object contains Group
objects.
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange
.
Implementação
public function get groupMemberships():ArrayCollection
public function set groupMemberships(value:ArrayCollection):void
Elementos da API relacionados
local | propriedade |
local:Boolean
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The user's local value.
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange
.
Implementação
public function get local():Boolean
public function set local(value:Boolean):void
locked | propriedade |
locked:Boolean
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
Versões de runtime: | 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.
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange
.
Implementação
public function get locked():Boolean
public function set locked(value:Boolean):void
oid | propriedade |
oid:String
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The unique identifier for the user called a object identifier.
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange
.
Implementação
public function get oid():String
public function set oid(value:String):void
org | propriedade |
org:String
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The user's organization name.
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange
.
Implementação
public function get org():String
public function set org(value:String):void
principalType | propriedade |
principalType:String
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The user's common domain main.
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange
.
Implementação
public function get principalType():String
public function set principalType(value:String):void
roleMembership | propriedade |
roleMembership:ArrayCollection
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
Versões de runtime: | 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.
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange
.
Implementação
public function get roleMembership():ArrayCollection
public function set roleMembership(value:ArrayCollection):void
Elementos da API relacionados
status | propriedade |
status:String
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The user's common domain main.
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange
.
Implementação
public function get status():String
public function set status(value:String):void
system | propriedade |
system:Boolean
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A flag value that specifies whether the principal is a system principal.
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange
.
Implementação
public function get system():Boolean
public function set system(value:Boolean):void
visibility | propriedade |
visibility:Number
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
Versões de runtime: | 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.
Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange
.
Implementação
public function get visibility():Number
public function set visibility(value:Number):void
addEventListener | () | método |
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).
Parâmetros
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 |
dispatchEvent | () | método |
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.
Parâmetros
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 | () | método |
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.
Parâmetros
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type is registered; false otherwise.
|
removeEventListener | () | método |
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.
Parâmetros
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 | () | método |
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.
Parâmetros
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.
|
Wed Jun 13 2018, 11:10 AM Z