com.plumtree.uiinfrastructure.pagecontrols.framework
Class AHTMLComponent

java.lang.Object
  extended by com.plumtree.uiinfrastructure.pagecontrols.framework.AComponent
      extended by com.plumtree.uiinfrastructure.pagecontrols.framework.AHTMLComponent
Direct Known Subclasses:
Button, HTMLCheckBox, HTMLCheckBoxGroup, HTMLCheckBoxGroupPlus, HTMLCheckBoxPlus, HTMLDuration, HTMLHidden, HTMLNameDescLang, HTMLPasswordBox, HTMLRadioButton, HTMLRadioButtonGroup, HTMLRadioButtonGroupPlus, HTMLRadioButtonPlus, HTMLSelectDropDown, HTMLTextAndDropDown, HTMLTextArea, HTMLTextBox, SubmitButton

public abstract class AHTMLComponent
extends AComponent

JF- This is the abstract class for all HTML Element page controls.

Author:
Julie Fournier

Field Summary
 
Fields inherited from class com.plumtree.uiinfrastructure.pagecontrols.framework.AComponent
m_ptPageMgr
 
Constructor Summary
AHTMLComponent()
          Creates an AHTML Component
 
Method Summary
 void AddValidator(IValidator _ptValidator)
          Add a validator to this component's collection of validators.
 ComponentMgr GetComponentMgr(PageMgr _ptPageMgr)
          Returns a ComponentMgr for this component.
 java.lang.String GetComponentMgrName()
          Returns the name of the ComponentMgr for this component.
protected abstract  java.lang.String GetHTMLComponentBaseName()
          JF- Returns the base name of this HTML Component.
 java.lang.String GetHTMLComponentName()
          JF- Returns the name of this HTML Component.
 java.lang.String GetHTMLComponentSize()
          JF- Returns the size of this HTML Component.
 PTStyleClass GetHTMLComponentStyleClass()
          JF- Returns the style class of this HTML Component.
 java.lang.String GetHTMLComponentValue()
          JF- Returns the value of this HTML Component.
 java.lang.String GetJSValidationCode()
          Return a string made up of all the JSValidationCode for each of the Validator's associated with this component.
 java.lang.String GetLabel()
          Returns the Label of this component
 XPArrayList GetValidators()
          Return the list of Validators associated with this object.
 void Init(PageMgr _ptPageMgr, java.lang.String _strUniqueInstanceID)
          JF- Initializes a new AHTMLComponent object.
 void SetHTMLComponentName(java.lang.String _sHTMLComponentName)
          JF- Sets the name of this HTML Component.
 void SetHTMLComponentSize(java.lang.String _sHTMLComponentSize)
          JF- Sets the size of this HTML Component.
 void SetHTMLComponentStyleClass(PTStyleClass _HTMLComponentStyleClass)
          JF- Sets the style class of this HTML Component.
 void SetHTMLComponentValue(java.lang.String _sHTMLComponentValue)
          JF- Sets the value of this HTML Component.
 void SetLabel(java.lang.String label)
          Sets the Label of this component
protected  HTMLInput SetParameters(HTMLInput _ptHTMLInput)
          Transfer the properties set to this object to the associated properties on the HTMLInput object.
 int StoreUserInput(XPHashtable _htRequestParameters)
          JF- Store the new value of this HTML component.
 XPArrayList Validate()
          Return an XPArrayList of UIError messages gathered by calling the validate() method on all Validators in this Component's collection of Validators.
 
Methods inherited from class com.plumtree.uiinfrastructure.pagecontrols.framework.AComponent
AppendUniqueIDToElementName, Create, GetComponentHeadContent, GetComponentHTML, GetComponentPostContent, GetComponentPreContent, GetComponentPreFormContent, GetName, GetPageMgr, GetSubComponentHTMLByIndex, GetUniqueInstanceID
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AHTMLComponent

public AHTMLComponent()
Creates an AHTML Component

Method Detail

Init

public void Init(PageMgr _ptPageMgr,
                 java.lang.String _strUniqueInstanceID)
JF- Initializes a new AHTMLComponent object.

Overrides:
Init in class AComponent
Parameters:
_ptComponentMgr - The component manager for this component.
_strUniqueInstanceID - The unique ID for this component.

StoreUserInput

public int StoreUserInput(XPHashtable _htRequestParameters)
JF- Store the new value of this HTML component.

Specified by:
StoreUserInput in class AComponent
Parameters:
_htRequestParameters -

AddValidator

public void AddValidator(IValidator _ptValidator)
Add a validator to this component's collection of validators.

Parameters:
_ptValidator - a validator to add to the list of validators owned by this component

Validate

public XPArrayList Validate()
Return an XPArrayList of UIError messages gathered by calling the validate() method on all Validators in this Component's collection of Validators.

Specified by:
Validate in class AComponent
Returns:
Arraylist of UIErrors.

GetValidators

public XPArrayList GetValidators()
Return the list of Validators associated with this object.

Specified by:
GetValidators in class AComponent
Returns:
XPArrayList of validators

GetJSValidationCode

public java.lang.String GetJSValidationCode()
Return a string made up of all the JSValidationCode for each of the Validator's associated with this component.

Returns:
JavaScript validation code

GetHTMLComponentBaseName

protected abstract java.lang.String GetHTMLComponentBaseName()
JF- Returns the base name of this HTML Component. E.g.: in_tx_pc

Returns:
String

GetHTMLComponentName

public java.lang.String GetHTMLComponentName()
JF- Returns the name of this HTML Component.

Returns:
String

GetHTMLComponentSize

public java.lang.String GetHTMLComponentSize()
JF- Returns the size of this HTML Component.

Returns:
String

GetHTMLComponentStyleClass

public PTStyleClass GetHTMLComponentStyleClass()
JF- Returns the style class of this HTML Component.

Returns:
PTStyleClass

GetHTMLComponentValue

public java.lang.String GetHTMLComponentValue()
JF- Returns the value of this HTML Component.

Returns:
String

SetHTMLComponentName

public void SetHTMLComponentName(java.lang.String _sHTMLComponentName)
JF- Sets the name of this HTML Component.

Parameters:
_sHTMLComponentName -

SetHTMLComponentSize

public void SetHTMLComponentSize(java.lang.String _sHTMLComponentSize)
JF- Sets the size of this HTML Component.

Parameters:
_sHTMLComponentSize -

SetHTMLComponentStyleClass

public void SetHTMLComponentStyleClass(PTStyleClass _HTMLComponentStyleClass)
JF- Sets the style class of this HTML Component.

Parameters:
_HTMLComponentStyleClass -

SetParameters

protected HTMLInput SetParameters(HTMLInput _ptHTMLInput)
Transfer the properties set to this object to the associated properties on the HTMLInput object. For example, Set the HTMLInput's styleClass with this object's GetHTMLComponentStyleClass.

Parameters:
_ptHTMLInput -
Returns:

SetHTMLComponentValue

public void SetHTMLComponentValue(java.lang.String _sHTMLComponentValue)
JF- Sets the value of this HTML Component.

Parameters:
_sHTMLComponentValue -

GetLabel

public java.lang.String GetLabel()
Returns the Label of this component

Returns:
Returns the m_sLabel member variable

SetLabel

public void SetLabel(java.lang.String label)
Sets the Label of this component

Parameters:
label - The m_sLabel to set

GetComponentMgr

public ComponentMgr GetComponentMgr(PageMgr _ptPageMgr)
Returns a ComponentMgr for this component. By default classes that extend AHTMLComponent may use this method to return the defualt ComponentMgr HTMLComponentMgr. If a component needs another ComponentMgr it should override this method.

Parameters:
_ptPageMgr - the PageMgr that the ComponentMgr is registered.
Returns:
the default ComponentMgr, HTMLComponentMgr.

GetComponentMgrName

public java.lang.String GetComponentMgrName()
Returns the name of the ComponentMgr for this component. By default classes that extend AHTMLComponent may use this method to return the defualt ComponentMgr name, HTMLComponentMgr.STR_CLASS_NAME. If a component needs another ComponentMgr it should override this method.

Returns:
the name of the default ComponentMgr, HTMLComponentMgr.STR_CLASS_NAME.



Copyright © 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.