ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
ga.model 

PanelManager  - AS3 ADEP Guides
Packagega.model
Classpublic class PanelManager
InheritancePanelManager Inheritance EventDispatcher Inheritance Object
Implements IHistoryManagerClient

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

The PanelManager class manages the list of visible panels on a Guide. The view classes use the panel manager as a source of the panels and to retrieve and select the current panel.

Note: The term "page" is synonymous with "panel". A page implements the IPanel interface.


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  currentPage : Page
[bindable] The currently selected panel.
PanelManager
  currentPageIndex : int
The index of the current page
PanelManager
  firstPage : Page
[read-only] Returns the first panel.
PanelManager
  gaModel : GuidedActivity
Returns the guided activity model
PanelManager
  instance : PanelManager
[static] Returns a single instance of the PanelManager class.
PanelManager
  lastPage : Page
[read-only] Returns the last panel.
PanelManager
  nextPage : Page
[read-only] [bindable] Returns the next panel, or null if none exists.
PanelManager
  pages : Array
[read-only] Returns the visible panels.
PanelManager
  previousPage : Page
[read-only] [bindable] Returns the previous panel, or null if none exists.
PanelManager
  selectedItem : Object
[bindable] Returns the current panel.
PanelManager
  submitRequestTimestamp : Date
PanelManager
Public Methods
 MethodDefined By
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
  
addPage():Boolean
If the panel is allowed to repeat, this method adds a new panel after the current panel.
PanelManager
  
addSection():Boolean
If the section is repeatable, this method adds a new section after the current section.
PanelManager
  
canGoForward():Boolean
Returns true if the user is allowed to change the panel due to validation.
PanelManager
  
copyPage():Boolean
If the panel is allowed to repeat, this method creates a copy of a panel and adds it after the current panel.
PanelManager
  
copySection():Boolean
If the section is repeatable, this method copies a new section after the current section.
PanelManager
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
  
goNextPage():void
Sets the next panel as the current panel.
PanelManager
  
goPreviousPage():void
Sets the previous panel as the current panel.
PanelManager
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
  
removePage():Boolean
If the panel is repeatable, this method removes the current panel.
PanelManager
  
removeSection():Boolean
If the section is repeatable, this method removes the current section.
PanelManager
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
  
submit():void
If the Submit button on the form contains a script, this method executes the script, validates the form data, and then submits the data to the server.
PanelManager
  
submitToUrl(xmlData:String, targetUrl:String, requireValidation:Boolean = false, window:String = "_self"):void
Send the panel data to the specified URL.
PanelManager
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
  
validate():Boolean
Validates the Guide data, and returns true if validation was successful.
PanelManager
  
validateNavigation(requestedPage:Page):Page
Returns true if the user is allowed to change to the panel provided due to validation.
PanelManager
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Events
Click for more information on events
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
  
errorStringChanged
 Dispatched by a page, panel, or section whenever the error string for a Guide field changes.PanelManager
  
initialized
 Dispatched when a Guide initializes.PanelManager
  
pageAdd
 Dispatched when a repeating panel is added to a Guide.PanelManager
  
pageRemove
 Dispatched when a repeating panel is removed from a Guide.PanelManager
  
pageSelectionChange
 Dispatched when a panel is selected.PanelManager
  
sectionAdd
 Dispatched when a repeating section is added to a Guide.PanelManager
  
sectionRemove
 Dispatched when a repeating section is removed from a Guide.PanelManager
Property Detail

currentPage

property
currentPage:Page

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

[bindable] The currently selected panel.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get currentPage():Page
    public function set currentPage(value:Page):void

currentPageIndex

property 
currentPageIndex:int

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

The index of the current page

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get currentPageIndex():int
    public function set currentPageIndex(value:int):void

firstPage

property 
firstPage:Page  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Returns the first panel.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get firstPage():Page

gaModel

property 
gaModel:GuidedActivity

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Returns the guided activity model

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get gaModel():GuidedActivity
    public function set gaModel(value:GuidedActivity):void

instance

property 
instance:PanelManager

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Returns a single instance of the PanelManager class.



Implementation
    public static function get instance():PanelManager
    public static function set instance(value:PanelManager):void

lastPage

property 
lastPage:Page  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Returns the last panel.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get lastPage():Page

nextPage

property 
nextPage:Page  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

[bindable] Returns the next panel, or null if none exists.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get nextPage():Page

pages

property 
pages:Array  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Returns the visible panels.



Implementation
    public function get pages():Array

previousPage

property 
previousPage:Page  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

[bindable] Returns the previous panel, or null if none exists.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get previousPage():Page

selectedItem

property 
selectedItem:Object

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

[bindable] Returns the current panel.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get selectedItem():Object
    public function set selectedItem(value:Object):void

submitRequestTimestamp

property 
submitRequestTimestamp:Date



Implementation
    public function get submitRequestTimestamp():Date
    public function set submitRequestTimestamp(value:Date):void
Method Detail

addPage

()method
public function addPage():Boolean

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

If the panel is allowed to repeat, this method adds a new panel after the current panel.

Returns
Boolean — Boolean true if the page was added.

addSection

()method 
public function addSection():Boolean

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

If the section is repeatable, this method adds a new section after the current section.

Returns
Boolean — Boolean true if the section was added.

canGoForward

()method 
public function canGoForward():Boolean

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Returns true if the user is allowed to change the panel due to validation.

Returns
Boolean — Boolean whether or not the user is allowed to page forward.

copyPage

()method 
public function copyPage():Boolean

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

If the panel is allowed to repeat, this method creates a copy of a panel and adds it after the current panel.

Returns
Boolean — Boolean whether or not the page was copied.

copySection

()method 
public function copySection():Boolean

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

If the section is repeatable, this method copies a new section after the current section.

Returns
Boolean — Boolean whether or not the section was copied.

goNextPage

()method 
public function goNextPage():void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Sets the next panel as the current panel.

goPreviousPage

()method 
public function goPreviousPage():void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Sets the previous panel as the current panel.

removePage

()method 
public function removePage():Boolean

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

If the panel is repeatable, this method removes the current panel.

Returns
Boolean — Boolean whether or not the page was removed.

removeSection

()method 
public function removeSection():Boolean

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

If the section is repeatable, this method removes the current section.

Returns
Boolean — Boolean whether or not the section was removed.

submit

()method 
public function submit():void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

If the Submit button on the form contains a script, this method executes the script, validates the form data, and then submits the data to the server.

submitToUrl

()method 
public function submitToUrl(xmlData:String, targetUrl:String, requireValidation:Boolean = false, window:String = "_self"):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Send the panel data to the specified URL. The results display in a new window.

Parameters

xmlData:String — the xml data to be submitted
 
targetUrl:String — the url to submit to
 
requireValidation:Boolean (default = false) — true if validation is required prior to submit
 
window:String (default = "_self") — the window to display the results of the submission

validate

()method 
public function validate():Boolean

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Validates the Guide data, and returns true if validation was successful. If validation fails, the GAEvent.GUIDE_VALIDATION_FAILED event is dispatched.

Returns
Boolean — Boolean true if validation was successful.

Related API Elements

ga.model.GAEvent

validateNavigation

()method 
public function validateNavigation(requestedPage:Page):Page

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Returns true if the user is allowed to change to the panel provided due to validation. Any previous panel is ok to go to, but may not be allowed to go to a next panel.

Parameters

requestedPage:Page — validations are run against all pages preceeding the requestedPage.

Returns
Page — either a panel with validation errors or the requested page.
Event Detail

errorStringChanged

 Event
Event Object Type: ga.model.GAEvent
property GAEvent.type = ga.model.GAEvent.ERROR_STRING_CHANGED

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Dispatched by a page, panel, or section whenever the error string for a Guide field changes.

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.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

initialized

 Event  
Event Object Type: ga.model.GAEvent
property GAEvent.type = ga.model.GAEvent.INITIALIZED

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Dispatched when a Guide initializes.

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.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

pageAdd

 Event  
Event Object Type: ga.model.GAEvent
property GAEvent.type = ga.model.GAEvent.PAGE_ADD

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Dispatched when a repeating panel is added to a Guide.

The properties of the event object have the following values:

PropertyValue
pageThe page that was added.
sectionThe section that contains the added page.
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.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

pageRemove

 Event  
Event Object Type: ga.model.GAEvent
property GAEvent.type = ga.model.GAEvent.PAGE_REMOVE

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Dispatched when a repeating panel is removed from a Guide.

The properties of the event object have the following values:

PropertyValue
pageThe page that was removed.
sectionThe section that contained the removed page.
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.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

pageSelectionChange

 Event  
Event Object Type: ga.model.GAEvent
property GAEvent.type = ga.model.GAEvent.PAGE_SELECTION_CHANGE

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Dispatched when a panel is selected.

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.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

sectionAdd

 Event  
Event Object Type: ga.model.GAEvent
property GAEvent.type = ga.model.GAEvent.SECTION_ADD

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Dispatched when a repeating section is added to a Guide.

The properties of the event object have the following values:

PropertyValue
sectionThe section that contained the removed page.
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.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

sectionRemove

 Event  
Event Object Type: ga.model.GAEvent
property GAEvent.type = ga.model.GAEvent.SECTION_REMOVE

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Dispatched when a repeating section is removed from a Guide.

The properties of the event object have the following values:

PropertyValue
sectionThe section that contained the removed page.
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.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy