Packagepotomac.ui
Classpublic dynamic class PageInput
InheritancePageInput Inheritance Object

A PageInput is a lightweight argument passed to a Page. For most pages, the input is typically null, but when multiple instances of a given page are required an input should be used. Inputs differentiate the different instances. For example, if a page works on an 'Employee' object, the input might contain the employee ID.

Inputs should not contain full model elements. Instead they should maintain as little information as possible to allow the model to be retrieved. This typically means the input should contain primary key information only. Inputs will be serialized and stored between application sessions. They will be deserialized and recreated in order to the user to shown the same pages that were shown during his last application session.

PageInput is a dynamic object. Developers are encouraged to write their own subclasses of PageInput but it isn't required. Dynamic properties can be attached to a PageInput. Integer and String dynamic properties will be automatically serialized and checked during #equals. Subclasses must re-implement #equals().


Public Properties
 PropertyDefined By
  icon : Class
The icon of the input.
PageInput
  title : String
The title of the input.
PageInput
Public Methods
 MethodDefined By
  
PageInput()
Creates an empty input.
PageInput
  
equals(otherInput:PageInput):Boolean
Returns true if the given input matches this input.
PageInput
Property Detail
iconproperty
icon:Class

The icon of the input. Setting this icon will override the icon set in the page's declared extension.


Implementation
    public function get icon():Class
    public function set icon(value:Class):void
titleproperty 
title:String

The title of the input. Setting this title will override the title set in the page's declared extension. This is useful when you have multiple instances of a page and need to allow the user to differentiate between them.


Implementation
    public function get title():String
    public function set title(value:String):void
Constructor Detail
PageInput()Constructor
public function PageInput()

Creates an empty input.

Method Detail
equals()method
public function equals(otherInput:PageInput):Boolean

Returns true if the given input matches this input. This method is used to prevent duplicate pages from opening. If a page with same id and matching input is already open, an attempt to open a the new page will result in the existing page receiving focus.

Parameters

otherInput:PageInput — input to check for equality.

Returns
Boolean — true if the inputs are matching.




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