Packagepotomac.ui
Classpublic class Page
InheritancePage Inheritance Object

A page is a high-level subsection of an application. Pages display UI through one or more Folders. Each page has one default Folder (with the id of "default") which is automatically created.


Public Properties
 PropertyDefined By
  descriptor : PageDescriptor
The descriptor for this page.
Page
  id : String
The id of this page.
Page
  input : PageInput
The input for this page.
Page
Public Methods
 MethodDefined By
  
Page()
Callers should not construct Page instances.
Page
  
closeFolder(folder:Folder):void
Closes the given folder.
Page
  
closeFolderByID(folderID:String):void
Closes the folder with the given id.
Page
  
containsDirty():Boolean
Returns true if this page contains any part which has unsaved changes.
Page
  
create(options:PageOptions):void
Creates the UI for this page.
Page
  
getContainer():Container
Returns the UI control for this page.
Page
  
getFolder(folderID:String):Folder
Returns the folder in this page with the given id or null if no matching folder is found.
Page
  
getFolders():Array
Returns an array of Folders that exist in this page.
Page
  
openFolder(folderID:String, folderType:String = null, options:FolderOptions = null, location:String = null, relativeTo:String = null, percent:int = 0):Folder
Creates a folder in this page.
Page
  
storeSettings():void
Stores the settings for this page so that subsequent recreations can maintain the same settings.
Page
Protected Methods
 MethodDefined By
  
getFolderExtensions(pageID:String, bundleService:IBundleService):Array
Returns all folder extensions declared for given page.
Page
Public Constants
 ConstantDefined By
  LOCATION_BOTTOM : String = bottom
[static]
Page
  LOCATION_LEFT : String = left
[static]
Page
  LOCATION_RIGHT : String = right
[static]
Page
  LOCATION_TOP : String = top
[static]
Page
Property Detail
descriptorproperty
descriptor:PageDescriptor

The descriptor for this page.


Implementation
    public function get descriptor():PageDescriptor
    public function set descriptor(value:PageDescriptor):void
idproperty 
id:String

The id of this page.


Implementation
    public function get id():String
    public function set id(value:String):void
inputproperty 
input:PageInput

The input for this page.


Implementation
    public function get input():PageInput
    public function set input(value:PageInput):void
Constructor Detail
Page()Constructor
public function Page()

Callers should not construct Page instances. They are constructed via PotomacUI.

Method Detail
closeFolder()method
public function closeFolder(folder:Folder):void

Closes the given folder.

Parameters

folder:Folder — folder to close.

closeFolderByID()method 
public function closeFolderByID(folderID:String):void

Closes the folder with the given id.

Parameters

folderID:String — id of the folder to close.

containsDirty()method 
public function containsDirty():Boolean

Returns true if this page contains any part which has unsaved changes.

Returns
Boolean — True if any part in any folder in this page has unsaved changes.
create()method 
public function create(options:PageOptions):void

Creates the UI for this page.

Parameters

options:PageOptions — page options

getContainer()method 
public function getContainer():Container

Returns the UI control for this page.

Returns
Container — the UI control for this page.
getFolder()method 
public function getFolder(folderID:String):Folder

Returns the folder in this page with the given id or null if no matching folder is found.

Parameters

folderID:String — id of folder to return.

Returns
Folder — a folder instance or null.
getFolderExtensions()method 
protected function getFolderExtensions(pageID:String, bundleService:IBundleService):Array

Returns all folder extensions declared for given page.

Parameters

pageID:String — id of the page.
 
bundleService:IBundleService — the main bundle service.

Returns
Array — an Array of Folder Extensions.
getFolders()method 
public function getFolders():Array

Returns an array of Folders that exist in this page.

Returns
Array — Array of Folders
openFolder()method 
public function openFolder(folderID:String, folderType:String = null, options:FolderOptions = null, location:String = null, relativeTo:String = null, percent:int = 0):Folder

Creates a folder in this page. If the location information (location,relativeTo,percent) is not specified, then the folder is opened in its declared (or persisted) location.

Parameters

folderID:String — id of the folder to open
 
folderType:String (default = null) — folder type to open or null for the default folder type.
 
options:FolderOptions (default = null) — folder options
 
location:String (default = null) — one of the LOCATION_constants
 
relativeTo:String (default = null) — the id of the folder that will be resized to accomodate this new folder
 
percent:int (default = 0) — the percent of the relativeTo folder's size which will be allocated to the new folder

Returns
Folder — the new folder
storeSettings()method 
public function storeSettings():void

Stores the settings for this page so that subsequent recreations can maintain the same settings.

Constant Detail
LOCATION_BOTTOMConstant
public static const LOCATION_BOTTOM:String = bottom

LOCATION_LEFTConstant 
public static const LOCATION_LEFT:String = left

LOCATION_RIGHTConstant 
public static const LOCATION_RIGHT:String = right

LOCATION_TOPConstant 
public static const LOCATION_TOP:String = top





Fri Sep 10 2010, 10:44 AM -04:00