| Package | ga.model |
| Class | public class PanelManager |
| Inheritance | PanelManager  EventDispatcher 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 |
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
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : 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
| Method | Defined By | ||
|---|---|---|---|
| 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 | |
If the panel is allowed to repeat, this method adds a new panel after the current panel. | PanelManager | ||
If the section is repeatable, this method adds a new section after the current section. | PanelManager | ||
Returns true if the user is allowed to change the panel due to validation. | PanelManager | ||
If the panel is allowed to repeat, this method creates a copy of a panel and adds it
after the current panel. | PanelManager | ||
If the section is repeatable, this method copies a new section after the current section. | PanelManager | ||
|
Dispatches an event into the event flow. | EventDispatcher | |
Sets the next panel as the current panel. | PanelManager | ||
Sets the previous panel as the current panel. | PanelManager | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
If the panel is repeatable, this method removes the current panel. | PanelManager | ||
If the section is repeatable, this method removes the current section. | PanelManager | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
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 | ||
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
Validates the Guide data, and returns true if validation was successful. | PanelManager | ||
Returns true if the user is allowed to change to the panel provided due to validation. | PanelManager | ||
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Events
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched by a page, panel, or section whenever the error string for a Guide field changes. | PanelManager | |||
| Dispatched when a Guide initializes. | PanelManager | |||
| Dispatched when a repeating panel is added to a Guide. | PanelManager | |||
| Dispatched when a repeating panel is removed from a Guide. | PanelManager | |||
| Dispatched when a panel is selected. | PanelManager | |||
| Dispatched when a repeating section is added to a Guide. | PanelManager | |||
| 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):voidcurrentPageIndex | 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):voidfirstPage | 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():PagegaModel | 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):voidinstance | 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):voidlastPage | 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():PagenextPage | 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():Pagepages | property |
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():PageselectedItem | 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):voidsubmitRequestTimestamp | property |
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.
ReturnsBoolean — 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.
ReturnsBoolean — 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.
ReturnsBoolean — 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.
ReturnsBoolean — 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.
ReturnsBoolean — 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.
ReturnsBoolean — 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.
ReturnsBoolean — 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) | |
window:String (default = "_self") |
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.
ReturnsBoolean — Boolean true if validation was successful.
|
Related API Elements
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.
|
Page — either a panel with validation errors or the requested page.
|
Event Detail
errorStringChanged | Event |
Event Object Type:
property GAEvent.type =
ga.model.GAEventproperty 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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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:
property GAEvent.type =
ga.model.GAEventproperty 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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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:
property GAEvent.type =
ga.model.GAEventproperty 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:
| Property | Value |
|---|---|
page | The page that was added. |
section | The section that contains the added page. |
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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:
property GAEvent.type =
ga.model.GAEventproperty 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:
| Property | Value |
|---|---|
page | The page that was removed. |
section | The section that contained the removed page. |
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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:
property GAEvent.type =
ga.model.GAEventproperty 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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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:
property GAEvent.type =
ga.model.GAEventproperty 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:
| Property | Value |
|---|---|
section | The section that contained the removed page. |
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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:
property GAEvent.type =
ga.model.GAEventproperty 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:
| Property | Value |
|---|---|
section | The section that contained the removed page. |
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
Thu Dec 6 2018, 01:12 PM -08:00