com.plumtree.uiinfrastructure.pagecontrols.htmlpagecontrols
Class HTMLRadioButtonGroup

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

All Implemented Interfaces:

IManagedObject, IMVCObject, IPageControl

public class HTMLRadioButtonGroup
extends AHTMLComponent
implements IPageControl

HTMLRadioButtonGroup class supports grouping of related radio buttons.

Author:

CaiusV

Field Summary

protected XPArrayList	m_radioButtons the array of ARadioButtons 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

HTMLRadioButtonGroup()
Default constructor.

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.
java.lang.String	GetSelectedValue() Return the currently selected value of the radio button group.
void	Init(PageMgr _ptPageMgr, java.lang.String _strUniqueInstanceID, java.lang.String[] _arrValues) Initializes a new HTMLRadioButtonGroup object made up of radio buttons with values passed in as the _arrValues argument.
void	SetDelimiter(HTMLElementCollection delimiter)
void	SetSelectedValue(java.lang.String strSelectedValue) Set the currently selected value of the radio button group.
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_radioButtons

protected XPArrayList m_radioButtons

the array of ARadioButtons owned by this group

Constructor Detail

HTMLRadioButtonGroup

public HTMLRadioButtonGroup()

Default constructor. Creates a new HTMLRadioButtonGroup object.

Method Detail

Init

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

Initializes a new HTMLRadioButtonGroup object made up of radio buttons with values passed in as the _arrValues argument.

Parameters:

_ptPageMgr - PageManager

_strUniqueInstanceID - Unique Instance ID

_arrValues - values for radio buttons

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 -

GetSelectedValue

public java.lang.String GetSelectedValue()

Return the currently selected value of the radio button group.

Returns:

XPArrayList of selected values

SetSelectedValue

public void SetSelectedValue(java.lang.String strSelectedValue)

Set the currently selected value of the radio button group.

GetDelimiter

public HTMLElementCollection GetDelimiter()

Returns:

Returns the m_ptDelimiter.

SetDelimiter

public void SetDelimiter(HTMLElementCollection delimiter)

Parameters:

delimiter - The m_ptDelimiter to set.