| Package | com.afcomponents.umap.events |
| Class | public class GroupEvent |
| Inheritance | GroupEvent flash.events.Event |
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.| Property | Defined by | ||
|---|---|---|---|
| index : int [read-only]
Returns value of
index property. | GroupEvent | ||
| markerGroup : MarkerGroup [read-only]
Returns value of
markerGroup property. | GroupEvent | ||
| Method | Defined 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 | ||
| Constant | Defined 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 | ||
| index | property |
index:int [read-only]
Returns value of index property.
public function get index():int
| markerGroup | property |
markerGroup:MarkerGroup [read-only]
Returns value of markerGroup property.
public function get markerGroup():MarkerGroup
| 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.
Parameterstype: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.
|
| clone | () | method |
public override function clone():EventClones the event.
ReturnsEvent |
| GROUP_CLICK | constant |
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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
markerGroup | The MarkerGroup instance over which click event occured. |
index | The index of MarkerGroup |
| GROUP_CLOSE | constant |
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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
markerGroup | The MarkerGroup instance over which close event occured. |
index | The index of MarkerGroup |
| GROUP_CREATE | constant |
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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
markerGroup | The MarkerGroup instance over which create event occured. |
index | The index of MarkerGroup |
| GROUP_DESTROY | constant |
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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
markerGroup | The MarkerGroup instance over which destroy event occured. |
index | The index of MarkerGroup |
| GROUP_DOUBLE_CLICK | constant |
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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
markerGroup | The MarkerGroup instance over which double click event occured. |
index | The index of MarkerGroup |
| GROUP_ERROR | constant |
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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
markerGroup | The MarkerGroup instance over which error event occured. |
index | The index of MarkerGroup |
| GROUP_ICON_OUT | constant |
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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
currentTarget |
The object that is actively processing the OverlayEvent object with an event listener. |
markerGroup | The MarkerGroup instance over which roll out event occured. |
index | The index of MarkerGroup |
| GROUP_ICON_OVER | constant |
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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
markerGroup | The MarkerGroup instance over which roll over event occured. |
index | The index of MarkerGroup |
| GROUP_OPEN | constant |
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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
markerGroup | The MarkerGroup instance over which open event occured. |
index | The index of MarkerGroup |