com.sssw.shr.page
Class AgpButtonCheck

java.lang.Object
 |
 +--com.sssw.shr.page.AgpTag
       |
       +--com.sssw.shr.page.AgpControlBase
             |
             +--com.sssw.shr.page.AgpButton
                   |
                   +--com.sssw.shr.page.AgpButtonCheck

All Implemented Interfaces:

AgiJavaScriptEnhanced, AgiPageControl, AgiPageSubmitProcessor, Cloneable, Externalizable, Serializable

public class AgpButtonCheck

extends AgpButton

HTML Checkbox control. A checkbox control can represent the state of a boolean (true/false) value. A filled or "checked" box indicates a true value, while an empty or unchecked box indicates a false value. Check Box controls work independently of each another, providing the ability to use multiple checkboxes for multiple conditions.

Properties:

Data Column, Enable HTML Generation, Name, State, Submit On Change

Events:

validationFailed, validationTest, valueChanged

See Also:

Serialized Form

Fields inherited from class com.sssw.shr.page.AgpTag

UNIT_PERCENT, UNIT_PIXEL

Constructor Summary

AgpButtonCheck()

Method Summary

Boolean	getBooleanState() Returns the state of the control as a Boolean object.
boolean	getState() Returns the state of the control.
boolean	getSubmitOnChange() Returns whether a Submit request is sent to the server when the control's value changes.
void	setBooleanState(Boolean state) Sets the state of the control as a Boolean object.
void	setState(boolean state) Sets the state of the control.
void	setSubmitOnChange(boolean submit_on_change) Specifies whether a Submit request is sent to the server when the control's value changes.

Methods inherited from class com.sssw.shr.page.AgpButton

addPageActionListener, removePageActionListener

Methods inherited from class com.sssw.shr.page.AgpControlBase

getName

Methods inherited from class com.sssw.shr.page.AgpTag

getBoolProperty, getEnableHTMLGeneration, getIntArrayProperty, getIntProperty, getIntPropertyUnit, getProperty, getStringArrayProperty, invalidateHTML, removeProperty, setEnableHTMLGeneration, setIntProperty, setProperty

Methods inherited from class java.lang.Object

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

Methods implemented from interface com.sssw.shr.page.AgiJavaScriptEnhanced

generateFunction, generateRepaintScript, generateScriptInitializers, getFunctionNameForMethod, getFunctionNames, getMethodNames, getScriptObjectName, isHTMLRepaintPending, isJavaScriptRepaintPending

Methods implemented from interface com.sssw.shr.page.AgiPageControl

generateHTML, getPrefix, notifyPageLoaded, notifyPageRequestBegin, notifyPageRequestEnd, notifyPostValue, notifyPostValues

Methods implemented from interface com.sssw.shr.page.AgiPageSubmitProcessor

notifySubmit

Methods implemented from interface java.io.Externalizable

readExternal, writeExternal

Constructor Detail

AgpButtonCheck

public AgpButtonCheck()

Method Detail

getState

public boolean getState()

Returns the state of the control. It can be true or false.

Example:

 		boolean b  = Checkbox1.getState();
 

See Also:

State property, AgpButtonCheck.setState(boolean state)

setState

public void setState(boolean state)

Sets the state of the control.

Parameters:

state - either true or false.

Example:

 		// force this checkbox to be checked
 		Checkbox1.setState(true);
 

See Also:

State property, AgpButtonCheck.getState()

getBooleanState

public Boolean getBooleanState()

Returns the state of the control as a Boolean object.

setBooleanState

public void setBooleanState(Boolean state)

Sets the state of the control as a Boolean object.

getSubmitOnChange

public boolean getSubmitOnChange()

Returns whether a Submit request is sent to the server when the control's value changes.

Example:

 		boolean b = Checkbox1.getSubmitOnChange();
 

See Also:

Submit On Change property, AgpButtonCheck.setSubmitOnChange(boolean submit_on_change)

setSubmitOnChange

public void setSubmitOnChange(boolean submit_on_change)

Specifies whether a Submit request is sent to the server when the control's value changes.

Parameters:

submit_on_change - true if a Submit request should be sent, otherwise false.

Example:

 		// make this control submit when the value changes
 		Checkbox1.setSubmitOnChange(true);
 

See Also:

Submit On Change property, AgpButtonCheck.getSubmitOnChange()