Packagecom.afcomponents.umap.events
Classpublic class OverlayEvent
InheritanceOverlayEvent Inheritance flash.events.Event

The OverlayEvent class defines events that are associated with the Overlay class and it's ancestors. These include the following events:

  • OverlayEvent.ADDED: dispatched when overlay has been added to a MapObjectContainer, e.g. Layer.
  • OverlayEvent.READY: dispatched when overlay enters ready state.
  • OverlayEvent.HIDE: dispatched when overlay becomes invisible.
  • OverlayEvent.SHOW: dispatched when overlay becomes visible.
  • OverlayEvent.CHANGED: dispatched when overlay properties have been changed.
  • OverlayEvent.BEFORE_REFRESH: dispatched when overlay position is about to be refrereshed.
  • OverlayEvent.REFRESH: dispatched when overlay position has been refrereshed.
  • OverlayEvent.BEFORE_REDRAW: dispatched when overlay is about to be redrawn.
  • OverlayEvent.REDRAW: dispatched when overlay has been redrawn.
  • OverlayEvent.CLICK: dispatched when overlay has been clicked.
  • OverlayEvent.DOUBLE_CLICK: dispatched when overlay has been double clicked.
  • OverlayEvent.MOUSE_DOWN: dispatched when user presses a mouse button over the overlay.
  • OverlayEvent.MOUSE_UP: dispatched when user releases a mouse button over the overlay.
  • OverlayEvent.MOUSE_MOVE: dispatched when user moves the mouse over the overlay.
  • OverlayEvent.ROLL_OVER: dispatched when user rolls over the overlay.
  • OverlayEvent.ROLL_OUT: dispatched when user rolls out the overlay.
  • OverlayEvent.DRAG: dispatched when user drags the overlay.
  • OverlayEvent.DRAG_START: dispatched when user starts dragging the overlay.
  • OverlayEvent.DRAG_STOP: dispatched when user stops dragging the overlay.
  • OverlayEvent.INFO_WINDOW_OPENED: dispatched when the InfoWindow has been opened with the overlay.
  • OverlayEvent.INFO_WINDOW_CLOSED: dispatched when the InfoWindow has been closed with the overlay.


    • Public Properties
     PropertyDefined by
      param : *
    [read-only] Returns value of param property.
    		OverlayEvent
    Public Methods
     MethodDefined by
      
    OverlayEvent(type:String, param:Boolean = null, bubbles:Boolean = false, cancelable:* = false)
    Creates an OverlayEvent object that contains information about overlay events.
    		OverlayEvent
      
    clone():Event
    Clones the event.
    		OverlayEvent
    Public Constants
     ConstantDefined by
      ADDED : String = "overlayAdded"
    [static] The OverlayEvent.ADDED constant defines the value of the type property of an overlayAdded event object.
    		OverlayEvent
      BEFORE_REDRAW : String = "overlayBeforeRedraw"
    [static] The OverlayEvent.BEFORE_REDRAW constant defines the value of the type property of an overlayBeforeRedraw event object.
    		OverlayEvent
      BEFORE_REFRESH : String = "overlayBeforeRefresh"
    [static] The OverlayEvent.BEFORE_REFRESH constant defines the value of the type property of an overlayBeforeRefresh event object.
    		OverlayEvent
      CHANGED : String = "overlayChanged"
    [static] The OverlayEvent.CHANGED constant defines the value of the type property of an overlayChange event object.
    		OverlayEvent
      CLICK : String = "overlayClick"
    [static] The OverlayEvent.CLICK constant defines the value of the type property of an overlayClick event object.
    		OverlayEvent
      DOUBLE_CLICK : String = "overlayDoubleClick"
    [static] The OverlayEvent.DOUBLE_CLICK constant defines the value of the type property of an overlayDoubleClick event object.
    		OverlayEvent
      DRAG : String = "overlayDrag"
    [static] The OverlayEvent.DRAG constant defines the value of the type property of an overlayDrag event object.
    		OverlayEvent
      DRAG_START : String = "overlayDragStart"
    [static] The OverlayEvent.DRAG_START constant defines the value of the type property of an overlayDragStart event object.
    		OverlayEvent
      DRAG_STOP : String = "overlayDragStop"
    [static] The OverlayEvent.DRAG_STOP constant defines the value of the type property of an overlayDragStop event object.
    		OverlayEvent
      HIDE : String = "overlayHide"
    [static] The OverlayEvent.HIDE constant defines the value of the type property of an overlayHide event object.
    		OverlayEvent
      INFO_WINDOW_CLOSED : String = "infoWindowClosed"
    [static] The OverlayEvent.INFO_WINDOW_CLOSED constant defines the value of the type property of an infoWindowClosed event object.
    		OverlayEvent
      INFO_WINDOW_OPENED : String = "infoWindowOpened"
    [static] The OverlayEvent.INFO_WINDOW_OPENED constant defines the value of the type property of an infoWindowOpened event object.
    		OverlayEvent
      MOUSE_DOWN : String = "overlayMouseDown"
    [static] The OverlayEvent.MOUSE_DOWN constant defines the value of the type property of an overlayMouseDown event object.
    		OverlayEvent
      MOUSE_MOVE : String = "overlayMouseMove"
    [static] The OverlayEvent.MOUSE_MOVE constant defines the value of the type property of an overlayMouseMove event object.
    		OverlayEvent
      MOUSE_UP : String = "overlayMouseUp"
    [static] The OverlayEvent.MOUSE_UP constant defines the value of the type property of an overlayMouseUp event object.
    		OverlayEvent
      READY : String = "overlayReady"
    [static] The OverlayEvent.READY constant defines the value of the type property of an overlayReady event object.
    		OverlayEvent
      REDRAW : String = "overlayRedraw"
    [static] The OverlayEvent.REDRAW constant defines the value of the type property of an overlayRedraw event object.
    		OverlayEvent
      REFRESH : String = "overlayRefresh"
    [static] The OverlayEvent.REFRESH constant defines the value of the type property of an overlayRefresh event object.
    		OverlayEvent
      ROLL_OUT : String = "overlayRollOut"
    [static] The OverlayEvent.ROLL_OUT constant defines the value of the type property of an overlayRollOut event object.
    		OverlayEvent
      ROLL_OVER : String = "overlayRollOver"
    [static] The OverlayEvent.ROLL_OVER constant defines the value of the type property of an overlayRollOver event object.
    		OverlayEvent
      SHOW : String = "overlayShow"
    [static] The OverlayEvent.SHOW constant defines the value of the type property of an overlayShow event object.
    		OverlayEvent
    Property detail
    paramproperty
    param:*  [read-only]

    Returns value of param property.

    Implementation
        public function get param():*
    Constructor detail
    OverlayEvent()constructor
    public function OverlayEvent(type:String, param:Boolean = null, bubbles:Boolean = false, cancelable:* = false)

    Creates an OverlayEvent object that contains information about overlay 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.
     
    param:Boolean (default = null) — Contains additional information associated with the event.
     
    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:* (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
    ADDEDconstant
    public static const ADDED:String = "overlayAdded"

    The OverlayEvent.ADDED constant defines the value of the type property of an overlayAdded 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 OverlayEvent object with an event listener.
    targetThe Overlay instance which has been added to MapObjectContainer.
    paramnull
    BEFORE_REDRAWconstant 
    public static const BEFORE_REDRAW:String = "overlayBeforeRedraw"

    The OverlayEvent.BEFORE_REDRAW constant defines the value of the type property of an overlayBeforeRedraw 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 OverlayEvent object with an event listener.
    targetThe Overlay instance that is going to be invalidated.
    paramnull
    BEFORE_REFRESHconstant 
    public static const BEFORE_REFRESH:String = "overlayBeforeRefresh"

    The OverlayEvent.BEFORE_REFRESH constant defines the value of the type property of an overlayBeforeRefresh 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 OverlayEvent object with an event listener.
    targetThe Overlay instance which position is about to be refreshed.
    paramA value of true if full refresh will be made; false if it will be not.
    CHANGEDconstant 
    public static const CHANGED:String = "overlayChanged"

    The OverlayEvent.CHANGED constant defines the value of the type property of an overlayChange 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 OverlayEvent object with an event listener.
    targetThe Overlay instance that has been changed.
    paramName of the property that has changed.
    CLICKconstant 
    public static const CLICK:String = "overlayClick"

    The OverlayEvent.CLICK constant defines the value of the type property of an overlayClick 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 OverlayEvent object with an event listener.
    targetThe Overlay instance that has been clicked.
    paramnull
    DOUBLE_CLICKconstant 
    public static const DOUBLE_CLICK:String = "overlayDoubleClick"

    The OverlayEvent.DOUBLE_CLICK constant defines the value of the type property of an overlayDoubleClick 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 OverlayEvent object with an event listener.
    targetThe Overlay instance that has been double clicked.
    paramnull
    DRAGconstant 
    public static const DRAG:String = "overlayDrag"

    The OverlayEvent.DRAG constant defines the value of the type property of an overlayDrag 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 OverlayEvent object with an event listener.
    targetThe Overlay instance which is being dragged.
    paramnull
    DRAG_STARTconstant 
    public static const DRAG_START:String = "overlayDragStart"

    The OverlayEvent.DRAG_START constant defines the value of the type property of an overlayDragStart 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 OverlayEvent object with an event listener.
    targetThe Overlay instance which has started being dragged.
    paramnull
    DRAG_STOPconstant 
    public static const DRAG_STOP:String = "overlayDragStop"

    The OverlayEvent.DRAG_STOP constant defines the value of the type property of an overlayDragStop 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 OverlayEvent object with an event listener.
    targetThe Overlay instance which has stopped being dragged.
    paramnull
    HIDEconstant 
    public static const HIDE:String = "overlayHide"

    The OverlayEvent.HIDE constant defines the value of the type property of an overlayHide 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 OverlayEvent object with an event listener.
    targetThe Overlay instance that has become invisible.
    paramnull
    INFO_WINDOW_CLOSEDconstant 
    public static const INFO_WINDOW_CLOSED:String = "infoWindowClosed"

    The OverlayEvent.INFO_WINDOW_CLOSED constant defines the value of the type property of an infoWindowClosed 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 OverlayEvent object with an event listener.
    targetThe Overlay instance that has closed an InfoWindow.
    paramnull
    INFO_WINDOW_OPENEDconstant 
    public static const INFO_WINDOW_OPENED:String = "infoWindowOpened"

    The OverlayEvent.INFO_WINDOW_OPENED constant defines the value of the type property of an infoWindowOpened 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 OverlayEvent object with an event listener.
    targetThe Overlay instance that has opened an InfoWindow.
    paramnull
    MOUSE_DOWNconstant 
    public static const MOUSE_DOWN:String = "overlayMouseDown"

    The OverlayEvent.MOUSE_DOWN constant defines the value of the type property of an overlayMouseDown 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 OverlayEvent object with an event listener.
    targetThe Overlay instance over which user pressed a mouse button.
    paramnull
    MOUSE_MOVEconstant 
    public static const MOUSE_MOVE:String = "overlayMouseMove"

    The OverlayEvent.MOUSE_MOVE constant defines the value of the type property of an overlayMouseMove 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 OverlayEvent object with an event listener.
    targetThe Overlay instance over which mouse have been moved.
    paramnull
    MOUSE_UPconstant 
    public static const MOUSE_UP:String = "overlayMouseUp"

    The OverlayEvent.MOUSE_UP constant defines the value of the type property of an overlayMouseUp 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 OverlayEvent object with an event listener.
    targetThe Overlay instance over which user released a mouse button.
    paramnull
    READYconstant 
    public static const READY:String = "overlayReady"

    The OverlayEvent.READY constant defines the value of the type property of an overlayReady 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 OverlayEvent object with an event listener.
    targetThe Overlay instance that has entered ready state.
    paramnull
    REDRAWconstant 
    public static const REDRAW:String = "overlayRedraw"

    The OverlayEvent.REDRAW constant defines the value of the type property of an overlayRedraw 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 OverlayEvent object with an event listener.
    targetThe Overlay instance that has been invalidated.
    paramnull
    REFRESHconstant 
    public static const REFRESH:String = "overlayRefresh"

    The OverlayEvent.REFRESH constant defines the value of the type property of an overlayRefresh 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 OverlayEvent object with an event listener.
    targetThe Overlay instance which position has been refreshed.
    paramA value of true if full refresh has been made; false if it has not.
    ROLL_OUTconstant 
    public static const ROLL_OUT:String = "overlayRollOut"

    The OverlayEvent.ROLL_OUT constant defines the value of the type property of an overlayRollOut 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 OverlayEvent object with an event listener.
    targetThe Overlay instance over which roll out event occured.
    paramnull
    ROLL_OVERconstant 
    public static const ROLL_OVER:String = "overlayRollOver"

    The OverlayEvent.ROLL_OVER constant defines the value of the type property of an overlayRollOver 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 OverlayEvent object with an event listener.
    targetThe Overlay instance over which a roll over event occured.
    paramnull
    SHOWconstant 
    public static const SHOW:String = "overlayShow"

    The OverlayEvent.SHOW constant defines the value of the type property of an overlayShow 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 OverlayEvent object with an event listener.
    targetThe Overlay instance that has become visible.
    paramnull



    © 2007-2008 advanced flash components