Guide de référence ActionScript® 3.0 pour la plate-forme Adobe® Flash®
Accueil  |  Masquer la liste des packages et des classes |  Packages  |  Classes  |  Nouveautés  |  Index  |  Annexes  |  Pourquoi existe-t-il du contenu en anglais ?
Filtres : Récupération des données du serveur...
Récupération des données du serveur...
lc.procmgmt.domain 

SearchTemplateDescriptor  - AS3 ADEP Workspace

Packagelc.procmgmt.domain
Classepublic class SearchTemplateDescriptor
HéritageSearchTemplateDescriptor Inheritance Object
Implémente IManagedObject, IManaged

Version du langage: ActionScript 3.0
Version du produit: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versions du moteur d’exécution: AIR (unsupported), Flash Player 9, Flash Player 10

The SearchTemplateDescriptor class is used for working with the search template descriptor. Search template descriptors are composed of a unique identifer, a name, a description, the service that is associated with a service, and the template to use for searching. The template is stored as XML.



Propriétés publiques
 PropriétéDéfini par
 Inheritedconstructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.
Object
  description : String
The description for a search template descriptor that is provided by the template creator.
SearchTemplateDescriptor
  id : Number
The unique identifier of the search template descriptor.
SearchTemplateDescriptor
  name : String
The name of the search template descriptor that is provided by the template creator.
SearchTemplateDescriptor
  service : String
The service name associated with the search template descriptor.
SearchTemplateDescriptor
  session : SessionMap
[lecture seule] A SessionMap object that stores information relating to the server session.
SearchTemplateDescriptor
Méthodes publiques
 MéthodeDéfini par
  
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.
SearchTemplateDescriptor
  
Dispatches an event into the event flow.
SearchTemplateDescriptor
  
Retrieves and populates a SearchFilter object based on the current name.
SearchTemplateDescriptor
  
getSearchFilterAttribute(attrScope:String, attrName:String, attrType:String, attrTitle:String = null):SearchFilterAttribute
Retrieves and populates a SearchFieldAttribute object.
SearchTemplateDescriptor
  
Retrieves and populates a SearchFieldCondition object.
SearchTemplateDescriptor
  
Retrieves and populates a SearchFieldSort object.
SearchTemplateDescriptor
  
Retrieves a search template based on the current ID.
SearchTemplateDescriptor
  
Retrieves a list of the search templates.
SearchTemplateDescriptor
  
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
SearchTemplateDescriptor
 Inherited
Indique si la propriété spécifiée d’un objet est définie.
Object
 Inherited
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre.
Object
 Inherited
Indique si la propriété spécifiée existe et est énumérable.
Object
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
SearchTemplateDescriptor
 Inherited
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.
Object
  
Sets a SessionMap object that stores the information relating to the server session.
SearchTemplateDescriptor
 Inherited
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.
Object
 Inherited
Renvoie la représentation sous forme de chaîne de l’objet spécifié.
Object
 Inherited
Renvoie la valeur primitive de l’objet spécifié.
Object
  
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
SearchTemplateDescriptor
Détails de la propriété

description

propriété
description:String

Version du langage: ActionScript 3.0
Version du produit: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versions du moteur d’exécution: AIR (unsupported), Flash Player 9, Flash Player 10

The description for a search template descriptor that is provided by the template creator.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .



Implémentation
    public function get description():String
    public function set description(value:String):void

id

propriété 
id:Number

Version du langage: ActionScript 3.0
Version du produit: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versions du moteur d’exécution: AIR (unsupported), Flash Player 9, Flash Player 10

The unique identifier of the search template descriptor.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .



Implémentation
    public function get id():Number
    public function set id(value:Number):void

name

propriété 
name:String

Version du langage: ActionScript 3.0
Version du produit: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versions du moteur d’exécution: AIR (unsupported), Flash Player 9, Flash Player 10

The name of the search template descriptor that is provided by the template creator.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .



Implémentation
    public function get name():String
    public function set name(value:String):void

service

propriété 
service:String

Version du langage: ActionScript 3.0
Version du produit: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versions du moteur d’exécution: AIR (unsupported), Flash Player 9, Flash Player 10

The service name associated with the search template descriptor.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .



Implémentation
    public function get service():String
    public function set service(value:String):void

session

propriété 
session:SessionMap  [lecture seule]

Version du langage: ActionScript 3.0
Version du produit: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versions du moteur d’exécution: AIR (unsupported), Flash Player 9, Flash Player 10

A SessionMap object that stores information relating to the server session.



Implémentation
    public function get session():SessionMap

Eléments de l’API associés

Détails de la méthode

addEventListener

()méthode
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).

Paramètres

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

()méthode 
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.

Paramètres

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

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

getSearchFilter

()méthode 
public function getSearchFilter():SearchFilter

Version du langage: ActionScript 3.0
Version du produit: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versions du moteur d’exécution: AIR (unsupported), Flash Player 9, Flash Player 10

Retrieves and populates a SearchFilter object based on the current name.

Valeur renvoyée
SearchFilter — A search filter based on the current name of the search filter descriptor.

Eléments de l’API associés

getSearchFilterAttribute

()méthode 
public function getSearchFilterAttribute(attrScope:String, attrName:String, attrType:String, attrTitle:String = null):SearchFilterAttribute

Version du langage: ActionScript 3.0
Version du produit: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versions du moteur d’exécution: AIR (unsupported), Flash Player 9, Flash Player 10

Retrieves and populates a SearchFieldAttribute object.

Paramètres

attrScope:String — Specifies the scope for the search filter.
 
attrName:String — Specifies the name of the search filter.
 
attrType:String — Specifies the type of the search filter.
 
attrTitle:String (default = null) — Specifies the title of the attribute.

Valeur renvoyée
SearchFilterAttribute — The search filter attribute based on the provided parameters.

Eléments de l’API associés

getSearchFilterCondition

()méthode 
public function getSearchFilterCondition(attribute:SearchFilterAttribute, operator:String, value1:String, value2:String = null):SearchFilterCondition

Version du langage: ActionScript 3.0
Version du produit: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versions du moteur d’exécution: AIR (unsupported), Flash Player 9, Flash Player 10

Retrieves and populates a SearchFieldCondition object.

Paramètres

attribute:SearchFilterAttribute — Specifies the search filter attribute.
 
operator:String — Specifies the operators to use in the search.
 
value1:String — Specifies search field condition.
 
value2:String (default = null) — Specifies other search field conditions.

Valeur renvoyée
SearchFilterCondition — The search filter condition.

Eléments de l’API associés

getSearchFilterSort

()méthode 
public function getSearchFilterSort(attribute:SearchFilterAttribute, precedence:int, direction:String):SearchFilterSort

Version du langage: ActionScript 3.0
Version du produit: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versions du moteur d’exécution: AIR (unsupported), Flash Player 9, Flash Player 10

Retrieves and populates a SearchFieldSort object.

Paramètres

attribute:SearchFilterAttribute — Specifies the attributes for sorting search filters.
 
precedence:int — Specifies the order in which to sort search filters.
 
direction:String — Specifies whether the search results are ascending or descending.

Valeur renvoyée
SearchFilterSort — A search filter sort.

Eléments de l’API associés

getSearchTemplate

()méthode 
public function getSearchTemplate():lc.foundation.util:ObjectToken

Version du langage: ActionScript 3.0
Version du produit: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versions du moteur d’exécution: AIR (unsupported), Flash Player 9, Flash Player 10

Retrieves a search template based on the current ID.

Valeur renvoyée
lc.foundation.util:ObjectToken — A search template.

getSearchTemplateDescriptors

()méthode 
public function getSearchTemplateDescriptors():lc.foundation.util:CollectionToken

Version du langage: ActionScript 3.0
Version du produit: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versions du moteur d’exécution: AIR (unsupported), Flash Player 9, Flash Player 10

Retrieves a list of the search templates.

Valeur renvoyée
lc.foundation.util:CollectionToken — A collection of search templates.

hasEventListener

()méthode 
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.

Paramètres

type:String — The type of event.

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

removeEventListener

()méthode 
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.

Paramètres

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.

setSession

()méthode 
public function setSession(session:SessionMap):void

Version du langage: ActionScript 3.0
Version du produit: Adobe Digital Enterprise Platform Document Services - Workspace 9
Versions du moteur d’exécution: AIR (unsupported), Flash Player 9, Flash Player 10

Sets a SessionMap object that stores the information relating to the server session.

Paramètres

session:SessionMap — Specifies the information relating to the server session.

willTrigger

()méthode 
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.

Paramètres

type:String — The type of event.

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




[ X ]Pourquoi existe-t-il du contenu en anglais ?
Certaines parties du Guide de référence ActionScript 3.0 sont en anglais

Tout le contenu du Guide de référence ActionScript 3.0 n’a pas été traduit dans toutes les langues. Si un élément de langage n’est pas traduit, il s’affiche en anglais. Par exemple, la classe ga.controls.HelpBox n’est traduite dans aucune langue. Ainsi, dans la version française du guide de référence, la classe ga.controls.HelpBox apparaît en anglais.