Packagecom.afcomponents.umap.events
Classpublic class GeocoderEvent
InheritanceGeocoderEvent Inheritance flash.events.Event

The GeocoderEvent class defines events that are associated with the GeocoderManager class, the defalaultGeocoderService class and it's ancestors. These include the following events:

  • GeocoderEvent.RESULT_READY: dispatched when the request has been executed.
  • GeocoderEvent.SUCCESS: dispatched when the request data has been parsed
  • GeocoderEvent.ERROR: dispatched when the
  • GeocoderEvent.CANCEL_REQUEST: dispatched when the request is
  • GeocoderEvent.STARTED_LOAD: dispatched when the request is


  • Public Properties
     PropertyDefined by
      request : GeocoderRequest
    [read-only] Returns value of request property.
    GeocoderEvent
      results : Array
    [read-only] Returns value of results property.
    GeocoderEvent
    Public Methods
     MethodDefined by
      
    GeocoderEvent(type:String, results:Array = null, request:GeocoderRequest = null, bubbles:Boolean = false, cancelable:Boolean = false)
    Creates an GeocoderEvent object that contains information about geocoder serive events.
    GeocoderEvent
      
    clone():Event
    Clones the event.
    GeocoderEvent
    Public Constants
     ConstantDefined by
      CANCEL_REQUEST : String = "geocoderCancelRequst"
    [static] The GeocoderEvent.CANCEL_REQUEST constant defines the value of the type property of an geocoderCancelRequest event object.
    GeocoderEvent
      ERROR : String = "geocoderError"
    [static] The GeocoderEvent.ERROR constant defines the value of the type property of an geocoderError event object.
    GeocoderEvent
      RESULTS_READY : String = "geocoderReady"
    [static] The GeocoderEvent.RESULTS_READY constant defines the value of the type property of an geocoderReady event object.
    GeocoderEvent
      STARTED_LOAD : String = "geocoderStartedLoad"
    [static] The GeocoderEvent.STARTED_LOAD constant defines the value of the type property of an geocoderStartedLoad event object.
    GeocoderEvent
      SUCCESS : String = "geocoderSuccess"
    [static] The GeocoderEvent.SUCCESS constant defines the value of the type property of an geocoderSuccess event object.
    GeocoderEvent
    Property detail
    requestproperty
    request:GeocoderRequest  [read-only]

    Returns value of request property.

    Implementation
        public function get request():GeocoderRequest
    resultsproperty 
    results:Array  [read-only]

    Returns value of results property.

    Implementation
        public function get results():Array
    Constructor detail
    GeocoderEvent()constructor
    public function GeocoderEvent(type:String, results:Array = null, request:GeocoderRequest = null, bubbles:Boolean = false, cancelable:Boolean = false)

    Creates an GeocoderEvent object that contains information about geocoder serive events. Event objects are passed as parameters to event listeners.

    Parameters
    type:String — The type of the event. Event listeners can access this information through the inherited type property.
     
    results:Array (default = null)
     
    request:GeocoderRequest (default = null)
     
    bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling phase of the event flow. Event listeners can access this information through the inherited bubbles property.
     
    cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property.
    Method detail
    clone()method
    public override function clone():Event

    Clones the event.

    Returns
    Event
    Constant detail
    CANCEL_REQUESTconstant
    public static const CANCEL_REQUEST:String = "geocoderCancelRequst"

    The GeocoderEvent.CANCEL_REQUEST constant defines the value of the type property of an geocoderCancelRequest event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the GeocoderEvent object with an event listener.
    targetThe .
    resultsnull
    requestThe reference to abortive request
    ERRORconstant 
    public static const ERROR:String = "geocoderError"

    The GeocoderEvent.ERROR constant defines the value of the type property of an geocoderError event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the GeocoderEvent object with an event listener.
    targetThe .
    resultsnull
    request
    RESULTS_READYconstant 
    public static const RESULTS_READY:String = "geocoderReady"

    The GeocoderEvent.RESULTS_READY constant defines the value of the type property of an geocoderReady event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the GeocoderEvent object with an event listener.
    targetThe .
    results
    request
    STARTED_LOADconstant 
    public static const STARTED_LOAD:String = "geocoderStartedLoad"

    The GeocoderEvent.STARTED_LOAD constant defines the value of the type property of an geocoderStartedLoad event object.

    This event has the following properties:

    null
    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the GeocoderEvent object with an event listener.
    targetThe .
    results
    request
    SUCCESSconstant 
    public static const SUCCESS:String = "geocoderSuccess"

    The GeocoderEvent.SUCCESS constant defines the value of the type property of an geocoderSuccess event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the GeocoderEvent object with an event listener.
    targetThe .
    results
    request