org.apache.tapestry.form
Class Hidden

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

All Implemented Interfaces:

IFormComponent, IComponent, ILocatable, ILocationHolder, IRender

public abstract class Hidden
extends AbstractFormComponent

Implements a hidden field within a Form. [Component Reference]

Version:

$Id: Hidden.java 243805 2004-02-26 16:11:20Z tsvetelin $

Author:

Howard Lewis Ship

Constructor Summary

Hidden()

Method Summary

protected void	finishLoad() Sets the encode parameter property to its default, true.
String	getElementId()
abstract boolean	getEncode() Returns true if the compent encodes object values using a DataSqueezer, false if values are always Strings.
abstract IBinding	getIdBinding()
abstract IActionListener	getListener()
abstract IBinding	getValueBinding()
boolean	isDisabled() Returns false.
protected void	renderComponent(IMarkupWriter writer, IRequestCycle cycle) Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle) to actually render the component (with any parameter values already set).
abstract void	setEncode(boolean encode)

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

Hidden

public Hidden()

Method Detail

renderComponent

protected void renderComponent(IMarkupWriter writer,
                               IRequestCycle cycle)

Description copied from class: AbstractComponent

Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle) to actually render the component (with any parameter values already set). This is the method that subclasses must implement.

Specified by:

renderComponent in class AbstractComponent

getElementId

public String getElementId()

getListener

public abstract IActionListener getListener()

getValueBinding

public abstract IBinding getValueBinding()

getIdBinding

public abstract IBinding getIdBinding()

isDisabled

public boolean isDisabled()

Returns false. Hidden components are never disabled.

Since:

2.2

getEncode

public abstract boolean getEncode()

Returns true if the compent encodes object values using a DataSqueezer, false if values are always Strings.

Since:

2.2

setEncode

public abstract void setEncode(boolean encode)

finishLoad

protected void finishLoad()

Sets the encode parameter property to its default, true.

Overrides:

finishLoad in class AbstractComponent

Since:

3.0