org.apache.tapestry.form
Class RadioGroup

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

All Implemented Interfaces:

IFormComponent, IComponent, ILocatable, ILocationHolder, IRender

public abstract class RadioGroup
extends AbstractFormComponent

A special type of form component that is used to contain Radio components. The Radio and Radio group components work together to update a property of some other object, much like a more flexible version of a PropertySelection. [Component Reference]

Version:

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

Author:

Howard Lewis Ship

Constructor Summary

RadioGroup()

Method Summary

static RadioGroup	get(IRequestCycle cycle)
int	getNextOptionId()
abstract IBinding	getSelectedBinding()
abstract boolean	isDisabled() Used by Radio components wrapped by this RadioGroup to see if the group as a whole is disabled.
boolean	isRewinding()
boolean	isSelected(int option) Used by Radio components when rewinding to see if their value was submitted.
boolean	isSelection(Object value) Returns true if the value is equal to the current selection for the group.
protected void	renderComponent(IMarkupWriter writer, IRequestCycle cycle) Doesn't actual render an HTML element as there is no direct equivalent for an HTML element.
void	updateSelection(Object value) Invoked by the Radio which is selected to update the property bound to the selected parameter.

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

RadioGroup

public RadioGroup()

Method Detail

get

public static RadioGroup get(IRequestCycle cycle)

getSelectedBinding

public abstract IBinding getSelectedBinding()

getNextOptionId

public int getNextOptionId()

isDisabled

public abstract boolean isDisabled()

Used by Radio components wrapped by this RadioGroup to see if the group as a whole is disabled.

isRewinding

public boolean isRewinding()

isSelection

public boolean isSelection(Object value)

Returns true if the value is equal to the current selection for the group. This is invoked by a Radio during rendering to determine if it should be marked 'checked'.

updateSelection

public void updateSelection(Object value)

Invoked by the Radio which is selected to update the property bound to the selected parameter.

isSelected

public boolean isSelected(int option)

Used by Radio components when rewinding to see if their value was submitted.

renderComponent

protected void renderComponent(IMarkupWriter writer,
                               IRequestCycle cycle)

Doesn't actual render an HTML element as there is no direct equivalent for an HTML element. A RadioGroup component exists to organize the Radio components it wraps (directly or indirectly). A Radio can finds its RadioGroup as a IRequestCycle attribute.

Specified by:

renderComponent in class AbstractComponent