org.apache.tapestry.form
Class Checkbox

java.lang.Object
  org.apache.tapestry.spec.BaseLocatable
      org.apache.tapestry.AbstractComponent
          org.apache.tapestry.form.AbstractFormComponent
              org.apache.tapestry.form.Checkbox

All Implemented Interfaces:

IFormComponent, IComponent, ILocatable, ILocationHolder, IRender

public abstract class Checkbox
extends AbstractFormComponent

Implements a component that manages an HTML <input type=checkbox> form element. [Component Reference]

Version:

$Id: Checkbox.java 243791 2004-02-19 17:38:13Z hlship $

Author:

Howard Lewis Ship

Constructor Summary

Checkbox()

Method Summary

abstract boolean	isDisabled() Returns true if the component is disabled.
abstract boolean	isSelected()
protected void	renderComponent(IMarkupWriter writer, IRequestCycle cycle) Renders the form elements, or responds when the form containing the element is submitted (by checking Form.isRewinding().
abstract void	setSelected(boolean selected)

Methods inherited from class org.apache.tapestry.form.AbstractFormComponent

getDisplayName, getForm, getForm, getName, setForm, setName

Methods inherited from class org.apache.tapestry.AbstractComponent

addAsset, addBody, addComponent, cleanupAfterRender, finishLoad, finishLoad, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, format, format, format, format, formatString, formatString, formatString, formatString, generateAttributes, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getChangeObserver, getComponent, getComponents, getContainer, getExtendedId, getId, getIdPath, getListeners, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, getString, pageEndRender, prepareForRender, render, renderBody, renderInformalParameters, setBinding, setContainer, setId, setNamespace, setPage, setProperty, setSpecification, toString

Methods inherited from class org.apache.tapestry.spec.BaseLocatable

getLocation, setLocation

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.tapestry.IComponent

addAsset, addBody, addComponent, finishLoad, getAsset, getAssets, getBinding, getBindingNames, getBindings, getComponent, getComponents, getContainer, getExtendedId, getId, getIdPath, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, getString, renderBody, setBinding, setContainer, setId, setNamespace, setPage, setProperty, setSpecification

Methods inherited from interface org.apache.tapestry.IRender

render

Methods inherited from interface org.apache.tapestry.ILocationHolder

setLocation

Methods inherited from interface org.apache.tapestry.ILocatable

getLocation

Constructor Detail

Checkbox

public Checkbox()

Method Detail

renderComponent

protected void renderComponent(IMarkupWriter writer,
                               IRequestCycle cycle)

Renders the form elements, or responds when the form containing the element is submitted (by checking Form.isRewinding().

In traditional HTML, many checkboxes would have the same name but different values. Under Tapestry, it makes more sense to have different names and a fixed value. For a checkbox, we only care about whether the name appears as a request parameter.

Specified by:

renderComponent in class AbstractComponent

isDisabled

public abstract boolean isDisabled()

Description copied from interface: IFormComponent

Returns true if the component is disabled. This is important when the containing form is submitted, since disabled parameters do not update their bindings.

isSelected

public abstract boolean isSelected()

Since:

2.2

setSelected

public abstract void setSelected(boolean selected)

Since:

2.2