org.apache.tapestry.dojo.form
Class Autocompleter

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

All Implemented Interfaces:

org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, IFormWidget, IWidget, IFormComponent, ValidatableField, IComponent, IDirect, IDirectEvent, IJSONRender, IRender

public abstract class Autocompleter
extends AbstractFormWidget
implements ValidatableField, IJSONRender, IDirect

An html field similar to a select input field that is wrapped by a dojo ComboBox widget.

Author:

jkuhnert

Constructor Summary

Autocompleter()

Method Summary

abstract IEngineService	getDirectService() Injected.
abstract java.lang.String	getFilter()
abstract IPropertySelectionModel	getModel()
abstract IScript	getScript() Injected.
abstract boolean	getSubmitOnChange()
abstract ValidatableFieldSupport	getValidatableFieldSupport() Injected.
abstract java.lang.Object	getValue()
abstract boolean	isFilterOnChange()
boolean	isRequired() Returns false.
boolean	isStateful() Invoked by the event service to query the component as to whether it is stateful.
void	renderComponent(IJSONWriter writer, IRequestCycle cycle) Renders a JSON object response back to the client.
protected void	renderFormWidget(IMarkupWriter writer, IRequestCycle cycle) Called when rendering a form widget.
protected void	rewindFormWidget(IMarkupWriter writer, IRequestCycle cycle) Called during form submission to retrieve submitted input values.
abstract void	setFilter(java.lang.String value)
abstract void	setValue(java.lang.Object value)
void	trigger(IRequestCycle cycle) Triggerd by using filterOnChange logic.

Methods inherited from class org.apache.tapestry.dojo.form.AbstractFormWidget

renderFormComponent, renderWidget, rewindFormComponent

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

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

Methods inherited from class org.apache.tapestry.AbstractComponent

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

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, getEventInvoker, 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

Methods inherited from interface org.apache.tapestry.IDirectEvent

triggerEvent

Constructor Detail

Autocompleter

public Autocompleter()

Method Detail

renderFormWidget

protected void renderFormWidget(IMarkupWriter writer,
                                IRequestCycle cycle)

Called when rendering a form widget.

Specified by:

renderFormWidget in class AbstractFormWidget

Parameters:

writer - The markup writer to render with.

cycle - The cycle associated with request.

renderComponent

public void renderComponent(IJSONWriter writer,
                            IRequestCycle cycle)

Renders a JSON object response back to the client. It should be assumed that if this method is called on a component it or one of the components it contains has been requested explicitly for rendering.

Specified by:

renderComponent in interface IJSONRender

Parameters:

writer - The json object writer used to write valid JSON responses.

cycle - Contextual request object.

rewindFormWidget

protected void rewindFormWidget(IMarkupWriter writer,
                                IRequestCycle cycle)

Description copied from class: AbstractFormWidget

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

Specified by:

rewindFormWidget in class AbstractFormWidget

Parameters:

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

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

See Also:

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

isStateful

public boolean isStateful()

Invoked by the event service to query the component as to whether it is stateful. If stateful and no HttpSession is active, then a StaleSessionException is thrown by the service.

Specified by:

isStateful in interface IDirect

Specified by:

isStateful in interface IDirectEvent

Overrides:

isStateful in class AbstractComponent

trigger

public void trigger(IRequestCycle cycle)

Triggerd by using filterOnChange logic. Invoked by the direct service to have the component peform the appropriate action. The DirectLink component will notify its listener.

Specified by:

trigger in interface IDirect

getModel

public abstract IPropertySelectionModel getModel()

isFilterOnChange

public abstract boolean isFilterOnChange()

Since:

4.1

getSubmitOnChange

public abstract boolean getSubmitOnChange()

Since:

2.2 *

getValue

public abstract java.lang.Object getValue()

Since:

2.2 *

setValue

public abstract void setValue(java.lang.Object value)

Since:

2.2 *

setFilter

public abstract void setFilter(java.lang.String value)

Since:

4.1

getFilter

public abstract java.lang.String getFilter()

Since:

4.1

getValidatableFieldSupport

public abstract ValidatableFieldSupport getValidatableFieldSupport()

Injected.

getDirectService

public abstract IEngineService getDirectService()

Injected.

Returns:

getScript

public abstract IScript getScript()

Injected.

Returns:

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()