This page describes an older version, please see latest API at http://resources.arcgis.com/en/help/flex-api/apiref/com/esri/ags/events/LocatorEvent.html.
Packagecom.esri.ags.events
Classpublic class LocatorEvent
InheritanceLocatorEvent Inheritance flash.events.Event

Represents event objects that are specific to Locator tasks.

See also

com.esri.ags.tasks.Locator
Live Sample - using LocatorEvent and locationToAddressComplete.


Public Properties
 PropertyDefined By
  addressCandidate : AddressCandidate
Address candidate.
LocatorEvent
  addressCandidates : Array
Array of AddressCandidate.
LocatorEvent
Public Methods
 MethodDefined By
  
LocatorEvent(type:String, addressCandidates:Array = null, addressCandidate:AddressCandidate = null)
Creates a new LocatorEvent.
LocatorEvent
Public Constants
 ConstantDefined By
  ADDRESS_TO_LOCATIONS_COMPLETE : String = addressToLocationsComplete
[static] Defines the value of the type property of an addressToLocationsComplete event object.
LocatorEvent
  LOCATION_TO_ADDRESS_COMPLETE : String = locationToAddressComplete
[static] Defines the value of the type property of a locationToAddressComplete event object.
LocatorEvent
Property Detail
addressCandidateproperty
public var addressCandidate:AddressCandidate

Address candidate. This property is set when the type is locationToAddressComplete

addressCandidatesproperty 
public var addressCandidates:Array

Array of AddressCandidate. This property is set when the type is addressToLocationsComplete.

See also

Constructor Detail
LocatorEvent()Constructor
public function LocatorEvent(type:String, addressCandidates:Array = null, addressCandidate:AddressCandidate = null)

Creates a new LocatorEvent.

Parameters
type:String — The event type; indicates the action that triggered the event.
 
addressCandidates:Array (default = null) — The array of addressCandidates associated with this event, or null.
 
addressCandidate:AddressCandidate (default = null) — The addressCandidate associated with this event, or null.
Constant Detail
ADDRESS_TO_LOCATIONS_COMPLETEConstant
public static const ADDRESS_TO_LOCATIONS_COMPLETE:String = addressToLocationsComplete

Defines the value of the type property of an addressToLocationsComplete event object.

LOCATION_TO_ADDRESS_COMPLETEConstant 
public static const LOCATION_TO_ADDRESS_COMPLETE:String = locationToAddressComplete

Defines the value of the type property of a locationToAddressComplete event object.