ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.ep.ux.content.event 

SearchEvent  - AS3 ADEP Content
Packagecom.adobe.ep.ux.content.event
Classpublic class SearchEvent
InheritanceSearchEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Event related to search action taken by user.


Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  searchFilter : SearchFilter
new search filter when user changes search criteria.
SearchEvent
  searchQuery : SearchQuery
searchQuery when doSearch or searchCompelete event is thrown.
SearchEvent
  searchResults : ListCollectionView
searchResults collection when searchComplete event is thrown.
SearchEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
SearchEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false)
Constructor.
SearchEvent
 Inherited
clone():Event
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  EVENT_DO_SEARCH : String = "doSearch"
[static] Type of event when search is to be executed.
SearchEvent
  EVENT_SEARCH_COMPLETE : String = "searchComplete"
[static] Type of event when search has completed
SearchEvent
  EVENT_SEARCH_FILTER_CHANGE : String = "searchFilterChange"
[static] Type of event when user changes search criteria
SearchEvent
Property Detail

searchFilter

property
public var searchFilter:SearchFilter

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

new search filter when user changes search criteria. used with event type searchFilterChange

searchQuery

property 
public var searchQuery:SearchQuery

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

searchQuery when doSearch or searchCompelete event is thrown.

searchResults

property 
public var searchResults:ListCollectionView

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

searchResults collection when searchComplete event is thrown.

Constructor Detail

SearchEvent

()Constructor
public function SearchEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false)

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Constructor.

Parameters
type:String — Type of Search Event
 
bubbles:Boolean (default = true) — Indicates whether an event is a bubbling event.
 
cancelable:Boolean (default = false) — Indicates whether the behavior associated with the event can be prevented.
Constant Detail

EVENT_DO_SEARCH

Constant
public static const EVENT_DO_SEARCH:String = "doSearch"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Type of event when search is to be executed.

EVENT_SEARCH_COMPLETE

Constant 
public static const EVENT_SEARCH_COMPLETE:String = "searchComplete"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Type of event when search has completed

EVENT_SEARCH_FILTER_CHANGE

Constant 
public static const EVENT_SEARCH_FILTER_CHANGE:String = "searchFilterChange"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Type of event when user changes search criteria




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy