com.plumtree.uiinfrastructure.pagecontrols.htmlpagecontrols
Class HTMLCheckBoxGroupPlus

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

All Implemented Interfaces:

IManagedObject, IMVCObject, IPageControl

public class HTMLCheckBoxGroupPlus
extends AHTMLComponent
implements IPageControl

HTMLCheckBoxGroupPlus class supports grouping of related checkboxplus objects.

Author:

CaiusV

Field Summary

protected XPArrayList	m_checkBoxes the array of checkboxes owned by this group
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

HTMLCheckBoxGroupPlus()
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.
HTMLCheckBoxPlus	GetElement(int _iIndex) Return a specific CheckBoxPlus object by index.
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.
int	GetSize() Return the number of CheckBoxPlus objects for this group.
void	Init(PageMgr _ptPageMgr, java.lang.String _strUniqueInstanceID, java.lang.String[] _strValues, java.lang.String[] _strLabels, HTMLImg[] _ptIcons, XPArrayList _ptURLs, java.lang.String[] _sDescs) Initializes a new ACheckBoxGroupPlus 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

protected XPArrayList m_checkBoxes

the array of checkboxes owned by this group

Constructor Detail

HTMLCheckBoxGroupPlus

public HTMLCheckBoxGroupPlus()

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,
                 HTMLImg[] _ptIcons,
                 XPArrayList _ptURLs,
                 java.lang.String[] _sDescs)

Initializes a new ACheckBoxGroupPlus object.

Parameters:

_ptPageMgr - the PageMgr responsible for this control

_strUniqueInstanceID - unique id

_strValues - the values for the checkboxes

_strLabels - the labels for the checkboxes

_ptIcons - icons for the checkboxes

_ptURLs - ASURLs for the checkboxes

_sDescs - Descriptions for the checkboxes

GetComponentHTML

public HTMLElementCollection GetComponentHTML()

Returns the HTML for this component. This is not a method that is often used. Rather, iterate over each CheckBoxPlus object and render them -- this way offers more flexible display options.

Specified by:

GetComponentHTML in interface IPageControl

Specified by:

GetComponentHTML in class AComponent

Returns:

HTMLElementCollection for display in a view

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.

GetSize

public int GetSize()

Return the number of CheckBoxPlus objects for this group.

Returns:

the number of CheckBoxPlus objects

GetElement

public HTMLCheckBoxPlus GetElement(int _iIndex)

Return a specific CheckBoxPlus object by index.

Parameters:

_iIndex - the index

Returns:

the CheckBoxPlus object at the index.

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

GetHTMLComponentBaseName

protected java.lang.String GetHTMLComponentBaseName()

Returns the base name of this HTML Component.

Specified by:

GetHTMLComponentBaseName in class AHTMLComponent

Returns:

String