com.ge.research.acuity.ui.helpers
Class PresentationObjectProperties

java.lang.Object
  extended bycom.ge.research.acuity.ui.helpers.PresentationObjectProperties

public final class PresentationObjectProperties
extends java.lang.Object

This class encapsulates and displays those properties of a PresentationObject that can be and should be displayed to a user for possible editing. Taking a PresentationObject as a constructor argument, the PresentationObject is introspected to find its members, which are then compared to the list of mapped properties within the PresentationParameterToUIEditPropertyMap instance. The PresentationParameterToUIEditPropertyMap is used to construct the PresentationObjects to display to the user, to allow them to change the value of the PresentationObject attributes. These PresentationObjects are stored in an ordered List for retrieval and rendering by the client application. For each PresentationObject contained by the constructor presentation object, another PresentationObjectProperties object is constructed and stored in the childPOProperties list for retrieval and rendering by the client application.

Version:
$Revision: 1.1 $ $Date: 2006/08/11 00:17:50 $
Author:
garbiras
Created on:
Feb 17, 2005

Constructor Summary
PresentationObjectProperties(PresentationObject po)
          Default constructor that takes a single PresentationObject as an argument, and if not null, creates the lists of edit property presentation objects for the attributes of this presentation object and any contained presentation objects
PresentationObjectProperties(PresentationObject po, java.lang.String name)
          Calls the default constructor and then sets the display name for the set of edit properties presentation objects
 
Method Summary
 java.util.List getChildPOP()
          Returns the List of PresentationObjectProperties for the PresentationObjects contained by the PresentationObject
 java.lang.String getPOName()
          Returns the display name for the set of editable properties of the PresentationObject
 java.util.List getPropertyPOs()
          Returns the List of PresentationObjects that represent the editable properties of the PresentationObject, and allow the user to modify their values
 void setPOName(java.lang.String name)
          Sets the display name for the set of editable properties of the PresentationObject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PresentationObjectProperties

public PresentationObjectProperties(PresentationObject po)
Default constructor that takes a single PresentationObject as an argument, and if not null, creates the lists of edit property presentation objects for the attributes of this presentation object and any contained presentation objects

Parameters:
po - the presentation object to introspect and construct edit parameter presentation objects for

PresentationObjectProperties

public PresentationObjectProperties(PresentationObject po,
                                    java.lang.String name)
Calls the default constructor and then sets the display name for the set of edit properties presentation objects

Parameters:
po - the presentation object to introspect and construct edit parameter presentation objects for
name - the display name for the set of user editable properties for the presentation object
See Also:
PresentationObjectProperties(com.ge.research.acuity.ui.PresentationObject), setPOName(java.lang.String)
Method Detail

getChildPOP

public java.util.List getChildPOP()
Returns the List of PresentationObjectProperties for the PresentationObjects contained by the PresentationObject

Returns:
The list of PresentationObjectProperties for the PresentationObjects contained by the PresentationObject

getPOName

public java.lang.String getPOName()
Returns the display name for the set of editable properties of the PresentationObject

Returns:
The display name for the set of editable properties of the PresentationObject

getPropertyPOs

public java.util.List getPropertyPOs()
Returns the List of PresentationObjects that represent the editable properties of the PresentationObject, and allow the user to modify their values

Returns:
The list of PresentationObjects used to modify the properties of the PresentationObject

setPOName

public void setPOName(java.lang.String name)
Sets the display name for the set of editable properties of the PresentationObject

Parameters:
name - the new display name for the set of presentation object properties edit presentation objects