com.plumtree.uiinfrastructure.pagecontrols.htmlpagecontrols
Class HTMLCheckBoxGroup

java.lang.Object
  com.plumtree.uiinfrastructure.pagecontrols.framework.AComponent
      com.plumtree.uiinfrastructure.pagecontrols.framework.AHTMLComponent
          com.plumtree.uiinfrastructure.pagecontrols.htmlpagecontrols.HTMLCheckBoxGroup

All Implemented Interfaces:

IManagedObject, IMVCObject, IPageControl

public class HTMLCheckBoxGroup
extends AHTMLComponent
implements IPageControl

HTMLCheckBoxGroup class supports grouping of related checkboxes.

Author:

CaiusV

Field Summary

XPArrayList	m_checkBoxes the array of checkboxes owned by this group
protected HTMLElementCollection	m_ptDelimiter delimits checkboxes
static java.lang.String	STR_MVC_CLASS_NAME this class name

Fields inherited from class com.plumtree.uiinfrastructure.pagecontrols.framework.AComponent

m_ptPageMgr

Constructor Summary

HTMLCheckBoxGroup()
Default constructor, creates a new HTMLCheckBox object

Method Summary

java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
HTMLElementCollection	GetComponentHTML() Returns the HTML for this component.
HTMLElementCollection	GetDelimiter()
protected java.lang.String	GetHTMLComponentBaseName() Returns the base name of this HTML Component.
java.lang.String	GetName() Return the name of the MVC object.
XPArrayList	GetSelectedValues() Return an XPArrayList containing the selected values.
void	Init(PageMgr _ptPageMgr, java.lang.String _strUniqueInstanceID, java.lang.String[] _strValues, java.lang.String[] _strLabels) Initializes a new ACheckBoxGroup object.
void	SetDelimiter(HTMLElementCollection delimiter)
void	SetSelectedValues(XPArrayList arrSelectedValues) Set the selected values for this object.
int	StoreUserInput(XPHashtable _htRequestParameters) Store the values of this HTML component.

Methods inherited from class com.plumtree.uiinfrastructure.pagecontrols.framework.AHTMLComponent

AddValidator, GetComponentMgr, GetComponentMgrName, GetHTMLComponentName, GetHTMLComponentSize, GetHTMLComponentStyleClass, GetHTMLComponentValue, GetJSValidationCode, GetLabel, GetValidators, Init, SetHTMLComponentName, SetHTMLComponentSize, SetHTMLComponentStyleClass, SetHTMLComponentValue, SetLabel, SetParameters, Validate

Methods inherited from class com.plumtree.uiinfrastructure.pagecontrols.framework.AComponent

AppendUniqueIDToElementName, GetComponentHeadContent, GetComponentPostContent, GetComponentPreContent, GetComponentPreFormContent, GetPageMgr, GetSubComponentHTMLByIndex, GetUniqueInstanceID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IPageControl

GetComponentMgr, GetComponentMgrName, GetUniqueInstanceID

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

this class name

See Also:

Constant Field Values

m_checkBoxes

public XPArrayList m_checkBoxes

the array of checkboxes owned by this group

m_ptDelimiter

protected HTMLElementCollection m_ptDelimiter

delimits checkboxes

Constructor Detail

HTMLCheckBoxGroup

public HTMLCheckBoxGroup()

Default constructor, creates a new HTMLCheckBox object

Method Detail

Init

public void Init(PageMgr _ptPageMgr,
                 java.lang.String _strUniqueInstanceID,
                 java.lang.String[] _strValues,
                 java.lang.String[] _strLabels)

Initializes a new ACheckBoxGroup object.

Parameters:

_ptPageMgr - the PageMgr where this object belongs

_strUniqueInstanceID - id for this obejct

_strValues - array of values for checkboxes

__strLabels - array of labels for checkboxes

GetHTMLComponentBaseName

protected java.lang.String GetHTMLComponentBaseName()

Returns the base name of this HTML Component.

Specified by:

GetHTMLComponentBaseName in class AHTMLComponent

Returns:

String

GetComponentHTML

public HTMLElementCollection GetComponentHTML()

Returns the HTML for this component.

Specified by:

GetComponentHTML in interface IPageControl

Specified by:

GetComponentHTML in class AComponent

Returns:

Create

public java.lang.Object Create()

This method is used by the ASManager to return new instances of managed objects.

Specified by:

Create in interface IManagedObject

Specified by:

Create in class AComponent

Returns:

A new instance of the managed class (i.e. return new Foo();)

GetName

public java.lang.String GetName()

Return the name of the MVC object.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class AComponent

Returns:

the name of the object.

StoreUserInput

public int StoreUserInput(XPHashtable _htRequestParameters)

Store the values of this HTML component.

Specified by:

StoreUserInput in interface IPageControl

Overrides:

StoreUserInput in class AHTMLComponent

Parameters:

_htRequestParameters -

GetSelectedValues

public XPArrayList GetSelectedValues()

Return an XPArrayList containing the selected values.

Returns:

XPArrayList of selected values

SetSelectedValues

public void SetSelectedValues(XPArrayList arrSelectedValues)

Set the selected values for this object.

Parameters:

arrSelectedValues -

GetDelimiter

public HTMLElementCollection GetDelimiter()

Returns:

Returns the m_ptDelimiter.

SetDelimiter

public void SetDelimiter(HTMLElementCollection delimiter)

Parameters:

delimiter - The m_ptDelimiter to set.