Packagecom.afcomponents.umap.events
Classpublic class GroupEvent
InheritanceGroupEvent Inheritance flash.events.Event

The GroupEvent class defines events that are associated with the MarkerGroup and MarkerManager classes. These include the following events:

  • GroupEvent.GROUP_CLICK: dispatched when the group marker has been clicked.
  • GroupEvent.GROUP_DOUBLE_CLICK: dispatched when the group marker has been double clicked.
  • GroupEvent.GROUP_ICON_OVER: dispatched when user rolls over the group marker.
  • GroupEvent.GROUP_ICON_OUT: dispatched when user rolls out the group marker.
  • GroupEvent.GROUP_CLOSE: dispatched when the marker group has been closed.
  • GroupEvent.GROUP_OPEN: dispatched when the marker group has been opened.
  • GroupEvent.GROUP_DESTROY: dispatched when the marker group has been destroyed.
  • GroupEvent.GROUP_CREATE: dispatched when the marker group has been created.
  • GroupEvent.GROUP_ERROR: dispatched when the error has been occurred.


  • Public Properties
     PropertyDefined by
      index : int
    [read-only] Returns value of index property.
    GroupEvent
      markerGroup : MarkerGroup
    [read-only] Returns value of markerGroup property.
    GroupEvent
    Public Methods
     MethodDefined by
      
    GroupEvent(type:String, markerGroup:MarkerGroup = null, index:int = -1, bubbles:Boolean = false, cancelable:Boolean = false)
    Creates an GroupEvent object that contains information about group events.
    GroupEvent
      
    clone():Event
    Clones the event.
    GroupEvent
    Public Constants
     ConstantDefined by
      GROUP_CLICK : String = "groupClick"
    [static] The GroupEvent.GROUP_CLICK constant defines the value of the type property of an groupClick event object.
    GroupEvent
      GROUP_CLOSE : String = "groupClose"
    [static] The GroupEvent.GROUP_CLOSE constant defines the value of the type property of an groupClose event object.
    GroupEvent
      GROUP_CREATE : String = "groupCreate"
    [static] The GroupEvent.GROUP_CREATE constant defines the value of the type property of an groupCreate event object.
    GroupEvent
      GROUP_DESTROY : String = "groupDestroy"
    [static] The GroupEvent.GROUP_DESTROY constant defines the value of the type property of an groupDestroy event object.
    GroupEvent
      GROUP_DOUBLE_CLICK : String = "groupDoubleClick"
    [static] The GroupEvent.GROUP_DOUBLE_CLICK constant defines the value of the type property of an groupDoubleClick event object.
    GroupEvent
      GROUP_ERROR : String = "groupError"
    [static] The GroupEvent.GROUP_ERROR constant defines the value of the type property of an groupError event object.
    GroupEvent
      GROUP_ICON_OUT : String = "groupIconOut"
    [static] The GroupEvent.GROUP_ICON_OUT constant defines the value of the type property of an groupIconOut event object.
    GroupEvent
      GROUP_ICON_OVER : String = "groupIconOver"
    [static] The GroupEvent.GROUP_ICON_OVER constant defines the value of the type property of an groupIconOver event object.
    GroupEvent
      GROUP_OPEN : String = "groupOpen"
    [static] The GroupEvent.GROUP_OPEN constant defines the value of the type property of an groupOpen event object.
    GroupEvent
    Property detail
    indexproperty
    index:int  [read-only]

    Returns value of index property.

    Implementation
        public function get index():int
    markerGroupproperty 
    markerGroup:MarkerGroup  [read-only]

    Returns value of markerGroup property.

    Implementation
        public function get markerGroup():MarkerGroup
    Constructor detail
    GroupEvent()constructor
    public function GroupEvent(type:String, markerGroup:MarkerGroup = null, index:int = -1, bubbles:Boolean = false, cancelable:Boolean = false)

    Creates an GroupEvent object that contains information about group 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.
     
    markerGroup:MarkerGroup (default = null) — Contains reference to MarkerGroup witch generate event.
     
    index:int (default = -1) — Contains index of MarkerGroup witch generate 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: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
    GROUP_CLICKconstant
    public static const GROUP_CLICK:String = "groupClick"

    The GroupEvent.GROUP_CLICK constant defines the value of the type property of an groupClick event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    markerGroupThe MarkerGroup instance over which click event occured.
    indexThe index of MarkerGroup
    GROUP_CLOSEconstant 
    public static const GROUP_CLOSE:String = "groupClose"

    The GroupEvent.GROUP_CLOSE constant defines the value of the type property of an groupClose event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    markerGroupThe MarkerGroup instance over which close event occured.
    indexThe index of MarkerGroup
    GROUP_CREATEconstant 
    public static const GROUP_CREATE:String = "groupCreate"

    The GroupEvent.GROUP_CREATE constant defines the value of the type property of an groupCreate event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    markerGroupThe MarkerGroup instance over which create event occured.
    indexThe index of MarkerGroup
    GROUP_DESTROYconstant 
    public static const GROUP_DESTROY:String = "groupDestroy"

    The GroupEvent.GROUP_DESTROY constant defines the value of the type property of an groupDestroy event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    markerGroupThe MarkerGroup instance over which destroy event occured.
    indexThe index of MarkerGroup
    GROUP_DOUBLE_CLICKconstant 
    public static const GROUP_DOUBLE_CLICK:String = "groupDoubleClick"

    The GroupEvent.GROUP_DOUBLE_CLICK constant defines the value of the type property of an groupDoubleClick event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    markerGroupThe MarkerGroup instance over which double click event occured.
    indexThe index of MarkerGroup
    GROUP_ERRORconstant 
    public static const GROUP_ERROR:String = "groupError"

    The GroupEvent.GROUP_ERROR constant defines the value of the type property of an groupError event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    markerGroupThe MarkerGroup instance over which error event occured.
    indexThe index of MarkerGroup
    GROUP_ICON_OUTconstant 
    public static const GROUP_ICON_OUT:String = "groupIconOut"

    The GroupEvent.GROUP_ICON_OUT constant defines the value of the type property of an groupIconOut 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.
    markerGroupThe MarkerGroup instance over which roll out event occured.
    indexThe index of MarkerGroup
    GROUP_ICON_OVERconstant 
    public static const GROUP_ICON_OVER:String = "groupIconOver"

    The GroupEvent.GROUP_ICON_OVER constant defines the value of the type property of an groupIconOver event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    markerGroupThe MarkerGroup instance over which roll over event occured.
    indexThe index of MarkerGroup
    GROUP_OPENconstant 
    public static const GROUP_OPEN:String = "groupOpen"

    The GroupEvent.GROUP_OPEN constant defines the value of the type property of an groupOpen event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    markerGroupThe MarkerGroup instance over which open event occured.
    indexThe index of MarkerGroup