org.apache.tapestry.dojo.form
Class AbstractFormWidget

java.lang.Object
  org.apache.hivemind.impl.BaseLocatable
      org.apache.tapestry.AbstractComponent
          org.apache.tapestry.form.AbstractFormComponent
              org.apache.tapestry.dojo.form.AbstractFormWidget

All Implemented Interfaces:

org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, IFormWidget, IWidget, IFormComponent, IComponent, IDirectEvent, Component, IRender

Direct Known Subclasses:

Autocompleter, DropdownDatePicker, DropdownTimePicker, GTimePicker

public abstract class AbstractFormWidget
extends AbstractFormComponent
implements IFormWidget

Represents a dojo widget that manages an html form input field.

Since:

4.1

Author:

jkuhnert

Field Summary

Fields inherited from class org.apache.tapestry.AbstractComponent

_body, _bodyCount

Constructor Summary

AbstractFormWidget()

Method Summary

abstract boolean	getDestroy() Determined dynamically at runtime during rendering, informs widget implementations if they should destroy their client side widget equivalents or leave them in tact.
protected void	renderFormComponent(IMarkupWriter writer, IRequestCycle cycle) Invoked from AbstractFormComponent.renderComponent(IMarkupWriter, IRequestCycle) to render the component.
protected abstract void	renderFormWidget(IMarkupWriter writer, IRequestCycle cycle) Called when rendering a form widget.
void	renderWidget(IMarkupWriter writer, IRequestCycle cycle) Similar to the semantics involved with normal AbstractComponent.renderComponent method writing component state to the output stream.
protected void	rewindFormComponent(IMarkupWriter writer, IRequestCycle cycle) Invoked from AbstractFormComponent.renderComponent(IMarkupWriter, IRequestCycle) to rewind the component.
protected abstract void	rewindFormWidget(IMarkupWriter writer, IRequestCycle cycle) Called during form submission to retrieve submitted input values.
abstract void	setDestroy(boolean destroy)

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

generateClientId, getCanTakeFocus, getForm, getIdParameter, getName, getRenderBodyOnRewind, isRequired, peekClientId, renderComponent, renderDelegateAttributes, renderDelegatePrefix, renderDelegateSuffix, setForm, setName, setName

Methods inherited from class org.apache.tapestry.AbstractComponent

addAsset, addBody, addComponent, checkActiveLock, cleanupAfterRender, enterActiveState, equals, finishLoad, finishLoad, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getBoundId, getClientId, getComponent, getComponents, getContainedComponent, getContainedRenderers, getContainer, getEventInvoker, getExtendedId, getId, getIdPath, getInnerRenderers, getListeners, getMessages, getNamespace, getPage, getRenderWorker, getSpecification, getSpecifiedId, getTemplateTagName, hasEvents, hashCode, isInActiveState, isParameterBound, isRendering, isStateful, pageEndRender, prepareForRender, render, renderBody, renderIdAttribute, renderInformalParameters, setBinding, setClientId, setContainedComponent, setContainer, setHasEvents, setId, setNamespace, setPage, setTemplateTagName, toString, triggerEvent

Methods inherited from class org.apache.hivemind.impl.BaseLocatable

getLocation, setLocation

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.tapestry.IDirectEvent

isStateful, triggerEvent

Methods inherited from interface org.apache.tapestry.IComponent

addAsset, addBody, addComponent, enterActiveState, finishLoad, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getClientId, getComponent, getComponents, getContainedComponent, getContainer, getEventInvoker, getExtendedId, getId, getIdPath, getListeners, getMessages, getNamespace, getPage, getSpecification, getSpecifiedId, getTemplateTagName, isRendering, peekClientId, renderBody, setBinding, setClientId, setContainedComponent, setContainer, setId, setNamespace, setPage, setTemplateTagName

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

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

getClientId, getDisplayName, isDisabled

Constructor Detail

AbstractFormWidget

public AbstractFormWidget()

Method Detail

setDestroy

public abstract void setDestroy(boolean destroy)

getDestroy

public abstract boolean getDestroy()

Determined dynamically at runtime during rendering, informs widget implementations if they should destroy their client side widget equivalents or leave them in tact.

Returns:

True if the widget should be destroyed on this render, false otherwise.

renderWidget

public void renderWidget(IMarkupWriter writer,
                         IRequestCycle cycle)

Similar to the semantics involved with normal AbstractComponent.renderComponent method writing component state to the output stream.

Specified by:

renderWidget in interface IWidget

Parameters:

writer - The markup writer used to write any output.

cycle - The corresponding request.

renderFormComponent

protected void renderFormComponent(IMarkupWriter writer,
                                   IRequestCycle cycle)

Invoked from AbstractFormComponent.renderComponent(IMarkupWriter, IRequestCycle) to render the component.

Specified by:

renderFormComponent in class AbstractFormComponent

rewindFormComponent

protected void rewindFormComponent(IMarkupWriter writer,
                                   IRequestCycle cycle)

Invoked from AbstractFormComponent.renderComponent(IMarkupWriter, IRequestCycle) to rewind the component. If the component is disabled this will not be invoked.

Specified by:

rewindFormComponent in class AbstractFormComponent

renderFormWidget

protected abstract void renderFormWidget(IMarkupWriter writer,
                                         IRequestCycle cycle)

Called when rendering a form widget.

Parameters:

writer - The markup writer to render with.

cycle - The cycle associated with request.

rewindFormWidget

protected abstract void rewindFormWidget(IMarkupWriter writer,
                                         IRequestCycle cycle)

Called during form submission to retrieve submitted input values. Components should do any validation/retrieval of values in this method.

Parameters:

writer - The passed in IMarkupWriter will be a NullWriter, making any content written ignored.

cycle - Typically used to retrieve submitted value via cycle.getParameter(getName()).