|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.uiinfrastructure.pagecontrols.framework.ComponentMgr
public class ComponentMgr
This class manages instances of like components that all appear on a single page. For more information on the page controls framework in general, please consult the documentation for AComponent. There is one important concept to understand when it comes to the ComponentMgr class: for page controls, there is script to be outputted that has "component scope" and script to be outputted that has "page scope." Component scope means that the data needs to be printed once per component. Page scope means that the data needs to be printed once per page, independent of the number of times a component of that type is written to the page. The component manager allows you to print data for either or both scopes through a series of methods. Components may be registered with the component manager and then obtained either using their unique instance ID or by way of an int index. The index is determined by the order in which you registered the components.
Field Summary | |
---|---|
java.lang.String |
STR_CLASS_NAME
class name constant |
Constructor Summary | |
---|---|
ComponentMgr(PageMgr _ptPageMgr)
Creates a new ComponentMgr object. |
Method Summary | |
---|---|
void |
AddToValidationFunction(AFormDP _ptAFormDP)
For all registered components, for every Validator associated with that component call AFormDP.AddToValidationFunction for the validator. |
HTMLElementCollection |
GetAllHeadContent()
This method returns ALL HTML--page scope and component scope for all components under this manger--that belongs between the HTML head tags. |
HTMLElementCollection |
GetAllPostContent()
This method returns ALL HTML--page scope and component scope for all components under this manger--that should be printed after the component itself. |
HTMLElementCollection |
GetAllPreContent()
This method returns ALL HTML--page scope and component scope for all components under this manger--that should be printed before the component itself. |
HTMLElementCollection |
GetAllPreFormContent()
This method returns ALL HTML--page scope and component scope for all components under this manger--that should be printed before the form in which this group of components is embedded. |
AComponent |
GetComponent(int _nIndex)
Returns an AComponent given an index. |
AComponent |
GetComponent(java.lang.String _strUniqueInstanceID)
This method returns an AComponent object given its unique instance ID. |
HTMLElementCollection |
GetComponentHeadContent(int _nIndex)
Returns the HTML for the designated component that is should be written out within the HTML head tags. |
HTMLElementCollection |
GetComponentHeadContent(java.lang.String _strUniqueInstanceID)
Returns the HTML for the designated component that is should be written out within the HTML head tags. |
HTMLElementCollection |
GetComponentHTML(int _nIndex)
Returns the HTML for the designated component. |
HTMLElementCollection |
GetComponentHTML(java.lang.String _strUniqueInstanceID)
Returns the HTML for the designated component. |
HTMLElementCollection |
GetComponentPostContent(int _nIndex)
Returns the HTML for the designated component that should be written out after the component itself. |
HTMLElementCollection |
GetComponentPostContent(java.lang.String _strUniqueInstanceID)
Returns the HTML for the designated component that should be written out after the component itself. |
HTMLElementCollection |
GetComponentPreContent(int _nIndex)
Returns the HTML for the designated component that should be written out before the component itself. |
HTMLElementCollection |
GetComponentPreContent(java.lang.String _strUniqueInstanceID)
Returns the HTML for the designated component that should be written out before the component itself. |
HTMLElementCollection |
GetComponentPreFormContent(int _nIndex)
Returns the HTML for the designated component that should be written out before the form in which the component is embedded. |
HTMLElementCollection |
GetComponentPreFormContent(java.lang.String _strUniqueInstanceID)
Returns the HTML for the designated component that should be written out before the form in which the component is embedded. |
java.lang.String |
GetJSValidationCode()
Return JavaScript validation code for each of the validators associated with all components. |
int |
GetNumComponents()
Returns the number of components registered with this component manger. |
HTMLElementCollection |
GetPageHeadContent()
This method is meant to return the page-level head content for components of this type. |
PageMgr |
GetPageMgr()
Returns the page manger that is associated with this component manager. |
HTMLElementCollection |
GetPagePostContent()
This method is meant to return the page-level "post" content for components of this type. |
HTMLElementCollection |
GetPagePreContent()
This method is meant to return the page-level head "pre" for components of this type. |
HTMLElementCollection |
GetPagePreFormContent()
This method is meant to return the page-level head content for components of this type. |
void |
RegisterComponent(IPageControl _ptComponent)
This method allows you to register a component with the component manager. |
int |
StoreAllUserInput(XPHashtable _htRequestParameters)
Stores the user input for all componets registered with this component manager. |
int |
StoreUserInput(int _nIndex,
XPHashtable _htRequestParameters)
This method stores the user input for a particular component given its index. |
void |
StoreUserInput(java.lang.String _strUniqueInstanceID,
XPHashtable _htRequestParameters)
This method stores the user input for a particular component given its unique ID. |
void |
UnRegisterComponent(java.lang.String _strUniqueInstanceID)
This method unregisters a component given its unique instance ID. |
XPArrayList |
Validate()
Call the validation method on all registered componenets. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public final java.lang.String STR_CLASS_NAME
Constructor Detail |
---|
public ComponentMgr(PageMgr _ptPageMgr)
_ptPageMgr
- The page manager for this component manager.Method Detail |
---|
public HTMLElementCollection GetAllHeadContent()
public HTMLElementCollection GetAllPostContent()
public HTMLElementCollection GetAllPreContent()
public HTMLElementCollection GetAllPreFormContent()
public AComponent GetComponent(java.lang.String _strUniqueInstanceID)
_strUniqueInstanceID
- The ID that uniquely represents the
component that you want.
public AComponent GetComponent(int _nIndex)
_nIndex
- The index of the component you want.
public HTMLElementCollection GetComponentHTML(java.lang.String _strUniqueInstanceID)
_strUniqueInstanceID
- The unique instance ID by which to identify
the component.
public HTMLElementCollection GetComponentHTML(int _nIndex)
_nIndex
- The index by which to identify the component.
public HTMLElementCollection GetComponentHeadContent(java.lang.String _strUniqueInstanceID)
_strUniqueInstanceID
- The unique instance ID by which to identify
the component.
public HTMLElementCollection GetComponentHeadContent(int _nIndex)
_nIndex
- The index by which to identify the component.
public HTMLElementCollection GetComponentPostContent(java.lang.String _strUniqueInstanceID)
_strUniqueInstanceID
- The unique instance ID by which to identify
the component.
public HTMLElementCollection GetComponentPostContent(int _nIndex)
_nIndex
- The index by which to identify the component.
public HTMLElementCollection GetComponentPreContent(java.lang.String _strUniqueInstanceID)
_strUniqueInstanceID
- The unique instance ID by which to identify
the component.
public HTMLElementCollection GetComponentPreContent(int _nIndex)
_nIndex
- The index by which to identify the component.
public HTMLElementCollection GetComponentPreFormContent(int _nIndex)
_nIndex
- The index by which to identify the component.
public HTMLElementCollection GetComponentPreFormContent(java.lang.String _strUniqueInstanceID)
_strUniqueInstanceID
- The unique instance ID by which to identify
the component.
public int GetNumComponents()
public HTMLElementCollection GetPageHeadContent()
public PageMgr GetPageMgr()
public HTMLElementCollection GetPagePostContent()
public HTMLElementCollection GetPagePreContent()
public HTMLElementCollection GetPagePreFormContent()
public void RegisterComponent(IPageControl _ptComponent)
_ptComponent
- The component that you wish to register.public int StoreAllUserInput(XPHashtable _htRequestParameters)
_htRequestParameters
- A hashtable of name-value pairs passed in
with the request.public XPArrayList Validate()
public java.lang.String GetJSValidationCode()
public void AddToValidationFunction(AFormDP _ptAFormDP)
_ptAFormDP
- AFormDP from the activity space where this ComponentMgr
is used.public void StoreUserInput(java.lang.String _strUniqueInstanceID, XPHashtable _htRequestParameters)
_strUniqueInstanceID
- The unique instance ID by which to identify
the component._htRequestParameters
- A hashtable of name-value pairs passed in
with the request.public int StoreUserInput(int _nIndex, XPHashtable _htRequestParameters)
_nIndex
- The index by which to identify the component._htRequestParameters
- A hashtable of name-value pairs passed in
with the request.public void UnRegisterComponent(java.lang.String _strUniqueInstanceID)
_strUniqueInstanceID
- The unique instance ID.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |