Packageat.events
Classpublic class AnnotationEvent
InheritanceAnnotationEvent Inheritance flash.events.Event

Defines all of the custom events for the AnnotationModule.



Public Properties
 PropertyDefined by
  annotationID : String
The id string for the annotation.
AnnotationEvent
  annotationIndex : uint
The index for the annotation in the section.
AnnotationEvent
  sectionIndex : uint
The index for the section of the annotation specified in the event.
AnnotationEvent
Public Methods
 MethodDefined by
  
AnnotationEvent(type:String, annotationID:String = null, sectionIndex:uint = 0, annotationIndex:uint = 0, bubbles:Boolean = false, cancelable:Boolean = false)
Constructor.
AnnotationEvent
Public Constants
 ConstantDefined by
  ANNOTATION_CHANGED : String = "annotationChanged"
[static] The type of the event when a new annotation has been selected.
AnnotationEvent
  DEINIT_COMPLETE : String = "deInitComplete"
[static] The AnnotationEvent.DEINIT_COMPLETE constant defines the value of the type property of the event object for a deInitComplete event.
AnnotationEvent
  INIT_COMPLETE : String = "initComplete"
[static] The AnnotationEvent.INIT_COMPLETE constant defines the value of the type property of the event object for a initComplete event.
AnnotationEvent
  SHOW_ANNOTATION_DETAIL : String = "showAnnotationDetail"
[static] The type for the switch when the AnnotationModule shows a detail of an annotation.
AnnotationEvent
  SHOW_ANNOTATION_LIST : String = "showAnnotationList"
[static] The type for the switch in the AnnotationModule when the list of sections is shown.
AnnotationEvent
Property detail
annotationIDproperty
public var annotationID:String

The id string for the annotation.

The default value is null.

annotationIndexproperty 
public var annotationIndex:uint

The index for the annotation in the section.

The default value is undefined.

sectionIndexproperty 
public var sectionIndex:uint

The index for the section of the annotation specified in the event.

The default value is undefined.

Constructor detail
AnnotationEvent()constructor
public function AnnotationEvent(type:String, annotationID:String = null, sectionIndex:uint = 0, annotationIndex:uint = 0, bubbles:Boolean = false, cancelable:Boolean = false)

Constructor.

Parameters
type:String — The type of the event
 
annotationID:String (default = null) — The id of the annotation
 
sectionIndex:uint (default = 0) — The section of annotation
 
annotationIndex:uint (default = 0) — Specifies if the event bubbles
 
bubbles:Boolean (default = false) — Specifies if the event can be cancelled
 
cancelable:Boolean (default = false)
Constant detail
ANNOTATION_CHANGEDconstant
public static const ANNOTATION_CHANGED:String = "annotationChanged"

The type of the event when a new annotation has been selected.

DEINIT_COMPLETEconstant 
public static const DEINIT_COMPLETE:String = "deInitComplete"

The AnnotationEvent.DEINIT_COMPLETE constant defines the value of the type property of the event object for a deInitComplete event.

INIT_COMPLETEconstant 
public static const INIT_COMPLETE:String = "initComplete"

The AnnotationEvent.INIT_COMPLETE constant defines the value of the type property of the event object for a initComplete event.

SHOW_ANNOTATION_DETAILconstant 
public static const SHOW_ANNOTATION_DETAIL:String = "showAnnotationDetail"

The type for the switch when the AnnotationModule shows a detail of an annotation.

SHOW_ANNOTATION_LISTconstant 
public static const SHOW_ANNOTATION_LIST:String = "showAnnotationList"

The type for the switch in the AnnotationModule when the list of sections is shown.