com.plumtree.uiinfrastructure.pagecontrols.htmlpagecontrols
Class HTMLRadioButtonGroupPlus

java.lang.Object
  extended by com.plumtree.uiinfrastructure.pagecontrols.framework.AComponent
      extended by com.plumtree.uiinfrastructure.pagecontrols.framework.AHTMLComponent
          extended by com.plumtree.uiinfrastructure.pagecontrols.htmlpagecontrols.HTMLRadioButtonGroupPlus
All Implemented Interfaces:
IManagedObject, IMVCObject, IPageControl

public class HTMLRadioButtonGroupPlus
extends AHTMLComponent
implements IPageControl

HTMLRadioButtonGroupPlus class supports grouping of related radiobuttons.

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
HTMLRadioButtonGroupPlus()
          Default constructor, creates a new HTMLRadioButton 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.
 HTMLRadioButtonPlus GetElement(int _iIndex)
          Return the RadioButtonPlus object at the given 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.
 java.lang.String GetSelectedValue()
          Return the currently selected value of the radio button group.
 int GetSize()
          Return the number of RadioButtons in 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 ARadioButtonGroupPlus object.
 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

HTMLRadioButtonGroupPlus

public HTMLRadioButtonGroupPlus()
Default constructor, creates a new HTMLRadioButton 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 ARadioButtonGroupPlus object. Assign values, labels, icons ASURLs and descriptions by passing in the appropriate arrays.

Parameters:
_ptPageMgr - PageManager
_strUniqueInstanceID - Unique Instance ID
_strValues - values for the radio buttons
_strLabels - labels for the radio buttons
_ptIcons - icons for the radio buttons
_ptURLs - ASURLs for the radio buttons
_sDescs - text descriptions for the radio buttons

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();)

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.


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 RadioButtons in this group

Returns:
number of RadioButtons

GetElement

public HTMLRadioButtonPlus GetElement(int _iIndex)
Return the RadioButtonPlus object at the given index.

Parameters:
_iIndex - the index of the returned button
Returns:
the RadioButtonPlus object at the given index

GetHTMLComponentBaseName

protected java.lang.String GetHTMLComponentBaseName()
Returns the base name of this HTML Component.

Specified by:
GetHTMLComponentBaseName in class AHTMLComponent
Returns:
String



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