HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.transform.html
Class CheckboxElement

java.lang.Object
  extended by com.ibm.hats.transform.html.HTMLElement
      extended by com.ibm.hats.transform.html.InputElement
          extended by com.ibm.hats.transform.html.CheckboxElement

public class CheckboxElement
extends InputElement

CheckboxElement is the HTMLElement which represents an HTML form check button such as the following:

 <input type="checkbox" name="gift_card" value="include_card" checked /> Include Gift Card
 
which appears as

Include Gift Card

See Also:
HTMLElementFactory.createCheckbox(InputComponentElement)

Field Summary
 
Fields inherited from class com.ibm.hats.transform.html.HTMLElement
ATTR_ACCESS_KEY, ATTR_ACTION, ATTR_ALT, ATTR_CLASS_NAME, ATTR_DIR, ATTR_FOR, ATTR_HREF, ATTR_ID, ATTR_IMG_ALT, ATTR_MAX_LENGTH, ATTR_NAME, ATTR_ON_BLUR, ATTR_ON_CHANGE, ATTR_ON_CLICK, ATTR_ON_CUT, ATTR_ON_DROP, ATTR_ON_FOCUS, ATTR_ON_KEY_DOWN, ATTR_ON_KEY_PRESS, ATTR_ON_KEY_UP, ATTR_ON_MOUSEDOWN, ATTR_ON_MOUSEOVER, ATTR_ON_PASTE, ATTR_SIZE, ATTR_SRC, ATTR_STYLE, ATTR_TARGET, ATTR_TYPE, ATTR_VALUE, CLASSNAME, FLAG_CHECKED, FLAG_DISABLED, FLAG_MULTIPLE, FLAG_READ_ONLY, FLAG_SELECTED, tagName
 
Constructor Summary
CheckboxElement()
          Class constructor for which sets the input type to checkbox.
 
Method Summary
 String getDescription()
          Returns the description.
 HTMLElement getDescriptionWrapper()
          Gets the description wrapper.
 boolean isSelected()
          Determines whether or not the checked flag has been set on this CheckboxElement.
 void render(StringBuffer buffer)
          Renders the input tag along with the description, if it exists.
 void setDescription(String description)
          Sets the description.
 void setDescriptionWrapper(HTMLElement element)
          Sets the description wrapper.
 void setSelected(boolean value)
          Adds or removes the checked flag on this CheckBoxElement.
 
Methods inherited from class com.ibm.hats.transform.html.InputElement
getOnBlur, getOnClick, getOnFocus, getType, getValue, isDisabled, renderEndTag, setDisabled, setOnBlur, setOnClick, setOnFocus, setType, setValue
 
Methods inherited from class com.ibm.hats.transform.html.HTMLElement
addFlag, appendClassName, appendStyle, buildTag, buildTag, getAttribute, getClassName, getDir, getId, getName, getStyle, getTagName, hasFlag, removeFlag, render, render, render, renderEndTag, setAlign, setAttribute, setClassName, setDir, setId, setName, setStyle, setTagName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CheckboxElement

public CheckboxElement()
Class constructor for which sets the input type to checkbox.

Method Detail

isSelected

public boolean isSelected()
Determines whether or not the checked flag has been set on this CheckboxElement.

Returns:
boolean

setSelected

public void setSelected(boolean value)
Adds or removes the checked flag on this CheckBoxElement.

Parameters:
value - true to add the flag, false to remove the flag

getDescription

public String getDescription()
Returns the description.

Returns:
String

setDescription

public void setDescription(String description)
Sets the description.

Parameters:
description - The description to set

getDescriptionWrapper

public HTMLElement getDescriptionWrapper()
Gets the description wrapper. This is used to enclose the description string in a div, font, or span tag.

Returns:
The description wrapper.

setDescriptionWrapper

public void setDescriptionWrapper(HTMLElement element)
Sets the description wrapper. This is used to enclose the description string in a div, font, or span tag.

Parameters:
element -

render

public void render(StringBuffer buffer)
Renders the input tag along with the description, if it exists. It is not necessary to render the closing tag.

Overrides:
render in class HTMLElement
See Also:
HTMLElement.render()

HATS 7.5.1 (201005110649)