com.plumtree.uiinfrastructure.pagecontrols.htmlpagecontrols
Class HTMLCheckBox

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

All Implemented Interfaces:

IManagedObject, IMVCObject, IPageControl

public class HTMLCheckBox
extends AHTMLComponent
implements IPageControl

Check box page control handles display and values of a check box.

Author:

CaiusV

Field Summary

HTMLInput	m_ptHTMLInput the HTMLInput object this wraps
static java.lang.String	STR_MVC_CLASS_NAME class name constant

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

m_ptPageMgr

Constructor Summary

HTMLCheckBox()
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.
protected java.lang.String	GetHTMLComponentBaseName() Returns the base name of this HTML Component.
java.lang.String	GetName() Return the name of the MVC object.
void	Init(PageMgr _ptPageMgr, java.lang.String _strUniqueInstanceID, java.lang.String _strValue) Initializes a new HTMLCheckBox object.
boolean	IsChecked() Returns the boolean checked attribute of this checkbox
void	SetChecked(boolean isChecked) Sets the boolean checked attribute of this checkbox.
int	StoreUserInput(XPHashtable _htRequestParameters) Store the new value 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

class name constant

See Also:

Constant Field Values

m_ptHTMLInput

public HTMLInput m_ptHTMLInput

the HTMLInput object this wraps

Constructor Detail

HTMLCheckBox

public HTMLCheckBox()

Default constructor. Creates a new empty HTMLCheckBox object.

Method Detail

Init

public void Init(PageMgr _ptPageMgr,
                 java.lang.String _strUniqueInstanceID,
                 java.lang.String _strValue)

Initializes a new HTMLCheckBox object.

Parameters:

_ptPageMgr - PageManager

_strUniqueInstanceID - Unique Instance ID

_strCols - Check Box Value

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 new value of this HTML component. Sets bChecked to true if the value of this checkbox is present in _htRequestParameters.

Specified by:

StoreUserInput in interface IPageControl

Overrides:

StoreUserInput in class AHTMLComponent

Parameters:

_htRequestParameters -

SetChecked

public void SetChecked(boolean isChecked)

Sets the boolean checked attribute of this checkbox.

Parameters:

isChecked - boolean

IsChecked

public boolean IsChecked()

Returns the boolean checked attribute of this checkbox

Returns:

boolean checked