org.apache.tapestry.form

Class RadioGroup

java.lang.Object

org.apache.hivemind.impl.BaseLocatable

org.apache.tapestry.AbstractComponent

org.apache.tapestry.form.AbstractFormComponent

org.apache.tapestry.form.RadioGroup

All Implemented Interfaces:

org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, IFormComponent, ValidatableField, IComponent, IRender

public abstract class RadioGroup
extends AbstractFormComponent
implements ValidatableField

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

As of 4.0, this component can be validated.

Author:

Howard Lewis Ship, Paul Ferraro

Constructor Summary

Constructors

Constructor and Description
RadioGroup()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	cleanupAfterRender(IRequestCycle cycle) Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle)after the component renders.
static RadioGroup	get(IRequestCycle cycle)
protected boolean	getAlwaysRenderBodyOnRewind() A small number of components should always render their body on rewind (even if the component is itself disabled) and should override this method to return true.
protected boolean	getCanTakeFocus() This component can not take focus.
int	getNextOptionId()
abstract ValidatableFieldSupport	getValidatableFieldSupport() Injected.
boolean	isRequired() Returns false.
boolean	isRewinding()
boolean	isSelected(int option) Used by Radiocomponents when rewinding to see if their value was submitted.
boolean	isSelection(java.lang.Object value) Returns true if the value is equal to the current selection for the group.
protected void	prepareForRender(IRequestCycle cycle) Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle)to prepare the component to render.
protected void	renderFormComponent(IMarkupWriter writer, IRequestCycle cycle)
protected void	rewindFormComponent(IMarkupWriter writer, IRequestCycle cycle)
void	updateSelection(java.lang.Object value) Invoked by the Radiowhich is selected to update the property bound to the selected parameter.

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

getForm, getIdParameter, getName, renderComponent, renderDelegateAttributes, renderDelegatePrefix, renderDelegateSuffix, renderIdAttribute, setClientId, setForm, setName, setName

Methods inherited from class org.apache.tapestry.AbstractComponent

addAsset, addBody, addComponent, checkActiveLock, enterActiveState, finishLoad, finishLoad, format, format, format, format, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getComponent, getComponents, getContainedComponent, getContainer, getExtendedId, getId, getIdPath, getListeners, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, isInActiveState, isParameterBound, isRendering, pageEndRender, render, renderBody, renderInformalParameters, setBinding, setContainedComponent, setContainer, setId, setNamespace, setPage, setProperty, toString

Methods inherited from class org.apache.hivemind.impl.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.form.ValidatableField

getValidators

Methods inherited from interface org.apache.tapestry.form.IFormComponent

getClientId, getDisplayName, getForm, getName, isDisabled, setName

Methods inherited from interface org.apache.tapestry.IComponent

addAsset, addBody, addComponent, enterActiveState, finishLoad, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getComponent, getComponents, getContainedComponent, getContainer, getExtendedId, getId, getIdPath, getListeners, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, isRendering, renderBody, setBinding, setContainedComponent, setContainer, setId, setNamespace, setPage, setProperty

Methods inherited from interface org.apache.tapestry.IRender

render

Methods inherited from interface org.apache.hivemind.LocationHolder

setLocation

Methods inherited from interface org.apache.hivemind.Locatable

getLocation

Constructor Detail

RadioGroup

public RadioGroup()

Method Detail

get

public static RadioGroup get(IRequestCycle cycle)

getNextOptionId

public int getNextOptionId()

isRewinding

public boolean isRewinding()

isSelection

public boolean isSelection(java.lang.Object value)

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

updateSelection

public void updateSelection(java.lang.Object value)

Invoked by the Radiowhich is selected to update the property bound to the selected parameter.

isSelected

public boolean isSelected(int option)

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

prepareForRender

protected void prepareForRender(IRequestCycle cycle)

Description copied from class: AbstractComponent

Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle)to prepare the component to render. This implementation sets JavaBeans properties from matching bound parameters. This implementation does nothing.

Overrides:

prepareForRender in class AbstractComponent

See Also:

AbstractComponent.prepareForRender(org.apache.tapestry.IRequestCycle)

cleanupAfterRender

protected void cleanupAfterRender(IRequestCycle cycle)

Description copied from class: AbstractComponent

Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle)after the component renders. This implementation does nothing.

Overrides:

cleanupAfterRender in class AbstractComponent

See Also:

AbstractComponent.cleanupAfterRender(org.apache.tapestry.IRequestCycle)

renderFormComponent

protected void renderFormComponent(IMarkupWriter writer,
                       IRequestCycle cycle)

Specified by:

renderFormComponent in class AbstractFormComponent

See Also:

org.apache.tapestry.form.AbstractRequirableField#renderFormComponent(org.apache.tapestry.IMarkupWriter, org.apache.tapestry.IRequestCycle)

rewindFormComponent

protected void rewindFormComponent(IMarkupWriter writer,
                       IRequestCycle cycle)

Specified by:

rewindFormComponent in class AbstractFormComponent

See Also:

AbstractFormComponent.rewindFormComponent(org.apache.tapestry.IMarkupWriter, org.apache.tapestry.IRequestCycle)

getValidatableFieldSupport

public abstract ValidatableFieldSupport getValidatableFieldSupport()

Injected.

isRequired

public boolean isRequired()

Description copied from class: AbstractFormComponent

Returns false. Subclasses that might be required must override this method. Typically, this involves checking against the component's validators.

Specified by:

isRequired in interface IFormComponent

Overrides:

isRequired in class AbstractFormComponent

See Also:

AbstractFormComponent.isRequired()

getCanTakeFocus

protected boolean getCanTakeFocus()

This component can not take focus.

Overrides:

getCanTakeFocus in class AbstractFormComponent

getAlwaysRenderBodyOnRewind

protected boolean getAlwaysRenderBodyOnRewind()

Description copied from class: AbstractFormComponent

A small number of components should always render their body on rewind (even if the component is itself disabled) and should override this method to return true. Components that explicitly render their body inside AbstractFormComponent.rewindFormComponent(IMarkupWriter, IRequestCycle) should leave this method returning false. Remember that if the component is disabled then AbstractFormComponent.rewindFormComponent(IMarkupWriter, IRequestCycle) won't be invoked.

Overrides:

getAlwaysRenderBodyOnRewind in class AbstractFormComponent

Returns:

false; override this method to change.

See Also:

org.apache.tapestry.form.AbstractFormComponent#getRenderBodyOnRewind()