ActionScript® 3.0 — dokumentacja dla platformy Adobe® Flash®
Strona główna  |  Ukryj listę pakietów i klas |  Pakiety  |  Klasy  |  Nowości  |  Indeks  |  Dodatki  |  Dlaczego język angielski?
Filtry: Pobieranie danych z serwera...
Pobieranie danych z serwera...
com.adobe.ep.ux.content.search 

SearchQuery  - AS3 ADEP Content

Pakietcom.adobe.ep.ux.content.search
Klasapublic class SearchQuery
DziedziczenieSearchQuery Inheritance Object
Implementuje IEventDispatcher

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Content 10
Wersje środowiska wykonawczego: Flash Player 10.2, AIR (unsupported)

Search Query wrapper for the list of searchFilters and associated AssetType on which the search is to be performed.



Właściwości publiczne
 WłaściwośćZdefiniowane przez
  assetDescList : IList
List of AssetDescriptor on which search is to be performed
SearchQuery
  assetDescriptor : com.adobe.ep.ux.content.model.asset:AssetTypeDescriptor
AssetDescriptor for the asset type on which search has to be performed.
SearchQuery
 Inheritedconstructor : Object
Odwołanie do obiektu klasy lub funkcji konstruktora, dotyczące danej instancji obiektu.
Object
  filters : IList
Search filters associated with the search query
SearchQuery
  searchParameters : SearchParameters
SearchParameters to be used while searching
SearchQuery
  sortFields : IList
SortFields to be used while sorting
SearchQuery
Metody publiczne
 MetodaZdefiniowane przez
  
SearchQuery(assetDescriptor:com.adobe.ep.ux.content.model.asset:AssetTypeDescriptor = null, filters:IList = null, assetDescList:IList = null, searchParameters:SearchParameters = null, sortFields:IList = null)
Constructor
SearchQuery
  
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.
SearchQuery
  
Dispatches an event into the event flow.
SearchQuery
  
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
SearchQuery
 Inherited
Wskazuje, czy dla obiektu zdefiniowano określoną właściwość.
Object
 Inherited
Wskazuje, czy instancja klasy Object należy do łańcucha prototypów obiektu określonego jako parametr.
Object
 Inherited
Wskazuje, czy określona właściwość istnieje i jest przeliczalna.
Object
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
SearchQuery
 Inherited
Ustawia dostępność właściwości dynamicznej używanej w pętlach.
Object
 Inherited
Zwraca ciąg reprezentujący obiekt — sformatowany zgodnie z konwencjami właściwymi dla ustawień regionalnych.
Object
 Inherited
Zwraca ciąg reprezentujący określony obiekt.
Object
 Inherited
Zwraca pierwotną wartość dla określonego obiektu.
Object
  
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
SearchQuery
Szczegół właściwości

assetDescList

właściwość
assetDescList:IList

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Content 10
Wersje środowiska wykonawczego: Flash Player 10.2, AIR (unsupported)

List of AssetDescriptor on which search is to be performed

Ta właściwość może być używana jako źródło dla tworzenia powiązań danych. Jeśli ta właściwość zostanie zmodyfikowana, zostanie wywołane zdarzenie propertyChange .



Implementacja
    public function get assetDescList():IList
    public function set assetDescList(value:IList):void

assetDescriptor

właściwość 
assetDescriptor:com.adobe.ep.ux.content.model.asset:AssetTypeDescriptor

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Content 10
Wersje środowiska wykonawczego: Flash Player 10.2, AIR (unsupported)

AssetDescriptor for the asset type on which search has to be performed.

Ta właściwość może być używana jako źródło dla tworzenia powiązań danych. Jeśli ta właściwość zostanie zmodyfikowana, zostanie wywołane zdarzenie propertyChange .



Implementacja
    public function get assetDescriptor():com.adobe.ep.ux.content.model.asset:AssetTypeDescriptor
    public function set assetDescriptor(value:com.adobe.ep.ux.content.model.asset:AssetTypeDescriptor):void

filters

właściwość 
filters:IList

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Content 10
Wersje środowiska wykonawczego: Flash Player 10.2, AIR (unsupported)

Search filters associated with the search query

Ta właściwość może być używana jako źródło dla tworzenia powiązań danych. Jeśli ta właściwość zostanie zmodyfikowana, zostanie wywołane zdarzenie propertyChange .



Implementacja
    public function get filters():IList
    public function set filters(value:IList):void

searchParameters

właściwość 
searchParameters:SearchParameters

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Content 10
Wersje środowiska wykonawczego: Flash Player 10.2, AIR (unsupported)

SearchParameters to be used while searching

Ta właściwość może być używana jako źródło dla tworzenia powiązań danych. Jeśli ta właściwość zostanie zmodyfikowana, zostanie wywołane zdarzenie propertyChange .



Implementacja
    public function get searchParameters():SearchParameters
    public function set searchParameters(value:SearchParameters):void

sortFields

właściwość 
sortFields:IList

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Content 10
Wersje środowiska wykonawczego: Flash Player 10.2, AIR (unsupported)

SortFields to be used while sorting

Ta właściwość może być używana jako źródło dla tworzenia powiązań danych. Jeśli ta właściwość zostanie zmodyfikowana, zostanie wywołane zdarzenie propertyChange .



Implementacja
    public function get sortFields():IList
    public function set sortFields(value:IList):void
Konstruktor Szczegół

SearchQuery

()Konstruktor
public function SearchQuery(assetDescriptor:com.adobe.ep.ux.content.model.asset:AssetTypeDescriptor = null, filters:IList = null, assetDescList:IList = null, searchParameters:SearchParameters = null, sortFields:IList = null)

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Content 10
Wersje środowiska wykonawczego: Flash Player 10.2, AIR (unsupported)

Constructor

Parametry
assetDescriptor:com.adobe.ep.ux.content.model.asset:AssetTypeDescriptor (default = null) — The base asset on which search is carried
 
filters:IList (default = null) — The Search Filters used while searching
 
assetDescList:IList (default = null) — The Asset list on which search is carried in case of multiple assets
 
searchParameters:SearchParameters (default = null) — The Search parameters to be used while search
 
sortFields:IList (default = null) — The sort fields used while sorting (optional)
Szczegół metody

addEventListener

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

Parametry

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

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

Parametry

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

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

hasEventListener

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

Parametry

type:String — The type of event.

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

removeEventListener

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

Parametry

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

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

Parametry

type:String — The type of event.

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




[ X ]Dlaczego język angielski?
Treść dokumentacji języka ActionScript 3.0 wyświetlana w języku angielskim

Niektóre części dokumentacji języka ActionScript 3.0 nie są przetłumaczone na poszczególne języki. Gdy element nie jest przetłumaczony na dany język, jest wyświetlany tekst angielski. Na przykład opis klasy ga.controls.HelpBox nie jest przetłumaczony na żaden dodatkowy język. Z tego powodu polska wersja dokumentacji zawiera opis klasy ga.controls.HelpBox w języku angielskim.