org.apache.tapestry.valid
Class FieldLabel

java.lang.Object
  |
  +--org.apache.tapestry.spec.BaseLocatable
        |
        +--org.apache.tapestry.AbstractComponent
              |
              +--org.apache.tapestry.valid.FieldLabel
All Implemented Interfaces:
IComponent, ILocatable, ILocationHolder, IRender

public abstract class FieldLabel
extends AbstractComponent

Used to label an IFormComponent. Because such fields know their displayName (user-presentable name), there's no reason to hard code the label in a page's HTML template (this also helps with localization). [Component Reference]

Version:
$Id: FieldLabel.java,v 1.11 2004/02/24 14:41:52 ehatcher Exp $
Author:
Howard Lewis Lewis Ship

Constructor Summary
FieldLabel()
           
 
Method Summary
abstract  String getDisplayName()
           
abstract  IFormComponent getField()
           
abstract  boolean getRaw()
           
protected  void renderComponent(IMarkupWriter writer, IRequestCycle cycle)
          Gets the IFormComponent and delegate, then renders the label obtained from the field.
 
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

FieldLabel

public FieldLabel()
Method Detail

renderComponent

protected void renderComponent(IMarkupWriter writer,
                               IRequestCycle cycle)
Gets the IFormComponent and delegate, then renders the label obtained from the field. Does nothing when rewinding.

Specified by:
renderComponent in class AbstractComponent

getDisplayName

public abstract String getDisplayName()

getField

public abstract IFormComponent getField()

getRaw

public abstract boolean getRaw()