Packagepotomac.ui
Classpublic class PartReference
InheritancePartReference Inheritance Object

A reference to a part in a folder. The part may or may not be created and its bundle may not yet be loaded. Potomac will attempt to load bundles and create parts only when required. Thus a part can be open (for example, you can see the part's tab) but the part itself, and potentially its bundle, have yet to be loaded. When the user selects the part's tab (or whatever folder UI mechanism is being used), Potomac will load any necessary bundles and create the part control.


Public Properties
 PropertyDefined By
  control : UIComponent
The part's control or null if the part is not yet created.
PartReference
  id : String
[read-only] The id of the part.
PartReference
  input : PartInput
[read-only] The part's input (potentially null).
PartReference
Public Methods
 MethodDefined By
  
PartReference(id:String, input:PartInput, control:UIComponent)
Callers should not construct PartReference instances.
PartReference
  
equals(otherRef:PartReference):Boolean
Returns true if the given reference matches this one.
PartReference
Property Detail
controlproperty
control:UIComponent

The part's control or null if the part is not yet created.


Implementation
    public function get control():UIComponent
    public function set control(value:UIComponent):void
idproperty 
id:String  [read-only]

The id of the part.


Implementation
    public function get id():String
inputproperty 
input:PartInput  [read-only]

The part's input (potentially null).


Implementation
    public function get input():PartInput
Constructor Detail
PartReference()Constructor
public function PartReference(id:String, input:PartInput, control:UIComponent)

Callers should not construct PartReference instances. PartReferences should be retreived via Folders.

Parameters
id:String
 
input:PartInput
 
control:UIComponent
Method Detail
equals()method
public function equals(otherRef:PartReference):Boolean

Returns true if the given reference matches this one.

Parameters

otherRef:PartReference — other reference to match.

Returns
Boolean — true if they match, false otherwise.




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