org.apache.tapestry.components
Class Conditional

java.lang.Object
  org.apache.tapestry.spec.BaseLocatable
      org.apache.tapestry.AbstractComponent
          org.apache.tapestry.components.Conditional

All Implemented Interfaces:

IComponent, ILocatable, ILocationHolder, IRender

Direct Known Subclasses:

Choose, When

public abstract class Conditional
extends AbstractComponent

A conditional element on a page which will render its wrapped elements zero or one times. [Component Reference]

Version:

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

Author:

Howard Lewis Ship, David Solis

Constructor Summary

Conditional()

Method Summary

protected boolean	evaluateCondition()
abstract boolean	getCondition()
abstract String	getElement()
abstract boolean	getInvert()
protected void	renderComponent(IMarkupWriter writer, IRequestCycle cycle) Renders its wrapped components only if the condition is true (technically, if condition matches invert).

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.ILocationHolder

setLocation

Methods inherited from interface org.apache.tapestry.ILocatable

getLocation

Constructor Detail

Conditional

public Conditional()

Method Detail

renderComponent

protected void renderComponent(IMarkupWriter writer,
                               IRequestCycle cycle)

Renders its wrapped components only if the condition is true (technically, if condition matches invert). Additionally, if element is specified, can emulate that HTML element if condition is met

Specified by:

renderComponent in class AbstractComponent

evaluateCondition

protected boolean evaluateCondition()

getCondition

public abstract boolean getCondition()

getInvert

public abstract boolean getInvert()

getElement

public abstract String getElement()