Packagepotomac.ui
Classpublic class PotomacEvent
InheritancePotomacEvent Inheritance flash.events.Event

Potomac events are dispatched when high-level UI actions occur.



Public Properties
 PropertyDefined By
  page : Page
[read-only] The relevant page.
PotomacEvent
  partReference : PartReference
[read-only] The relevant part reference.
PotomacEvent
Public Methods
 MethodDefined By
  
PotomacEvent(type:String, partRef:PartReference, page:Page)
Callers should not construct PotomacEvents.
PotomacEvent
Public Constants
 ConstantDefined By
  PAGE_CLOSED : String = potomacPageClosed
[static] The PotomacEvent.PAGE_CLOSED constant defines the value of the type property of the event object for a potomacPageClosed event.
PotomacEvent
  PAGE_SAVED : String = potomacPageSaved
[static] The PotomacEvent.PAGE_SAVED constant defines the value of the type property of the event object for a potomacPageSaved event.
PotomacEvent
  PAGE_SAVE_ERROR : String = potomacPageSaveError
[static] The PotomacEvent.PAGE_SAVE_ERROR constant defines the value of the type property of the event object for a potomacPageSaveError event.
PotomacEvent
  PART_CLOSED : String = potomacPartClosed
[static] The PotomacEvent.PART_CLOSED constant defines the value of the type property of the event object for a potomacPartClosed event.
PotomacEvent
  PART_DIRTY_CHANGE : String = potomacPartDirtyChange
[static] The PotomacEvent.PART_DIRTY_CHANGE constant defines the value of the type property of the event object for a potomacPartDirtyChange event.
PotomacEvent
  PART_SAVED : String = potomacPartSaved
[static] The PotomacEvent.PART_SAVED constant defines the value of the type property of the event object for a potomacPartSaved event.
PotomacEvent
  PART_SAVE_ERROR : String = potomacPartSaveError
[static] The PotomacEvent.PART_SAVE_ERROR constant defines the value of the type property of the event object for a potomacPartSaveError event.
PotomacEvent
Property Detail
pageproperty
page:Page  [read-only]

The relevant page.


Implementation
    public function get page():Page
partReferenceproperty 
partReference:PartReference  [read-only]

The relevant part reference.


Implementation
    public function get partReference():PartReference
Constructor Detail
PotomacEvent()Constructor
public function PotomacEvent(type:String, partRef:PartReference, page:Page)

Callers should not construct PotomacEvents.

Parameters
type:String
 
partRef:PartReference
 
page:Page
Constant Detail
PAGE_CLOSEDConstant
public static const PAGE_CLOSED:String = potomacPageClosed

The PotomacEvent.PAGE_CLOSED constant defines the value of the type property of the event object for a potomacPageClosed event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
partReferencenull
pageThe page which was closed.

PAGE_SAVE_ERRORConstant 
public static const PAGE_SAVE_ERROR:String = potomacPageSaveError

The PotomacEvent.PAGE_SAVE_ERROR constant defines the value of the type property of the event object for a potomacPageSaveError event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
partReferencenull
pageThe page in which one or more parts failed saving.

PAGE_SAVEDConstant 
public static const PAGE_SAVED:String = potomacPageSaved

The PotomacEvent.PAGE_SAVED constant defines the value of the type property of the event object for a potomacPageSaved event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
partReferencenull
pageThe page which was saved.

PART_CLOSEDConstant 
public static const PART_CLOSED:String = potomacPartClosed

The PotomacEvent.PART_CLOSED constant defines the value of the type property of the event object for a potomacPartClosed event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
partReferenceA reference to the closed part.
pagenull

PART_DIRTY_CHANGEConstant 
public static const PART_DIRTY_CHANGE:String = potomacPartDirtyChange

The PotomacEvent.PART_DIRTY_CHANGE constant defines the value of the type property of the event object for a potomacPartDirtyChange event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
partReferenceA reference to the part in which the dirty state changed.
pageThe page which contains the part whose dirty state changed.

PART_SAVE_ERRORConstant 
public static const PART_SAVE_ERROR:String = potomacPartSaveError

The PotomacEvent.PART_SAVE_ERROR constant defines the value of the type property of the event object for a potomacPartSaveError event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
partReferenceA reference to the part in which the save failed.
pagenull

PART_SAVEDConstant 
public static const PART_SAVED:String = potomacPartSaved

The PotomacEvent.PART_SAVED constant defines the value of the type property of the event object for a potomacPartSaved event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
partReferenceA reference to the saved part.
pagenull