org.apache.tapestry.valid
Class FieldLabel

java.lang.Object
  extended by org.apache.hivemind.impl.BaseLocatable
      extended by org.apache.tapestry.AbstractComponent
          extended by org.apache.tapestry.valid.FieldLabel
All Implemented Interfaces:
org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, IComponent, 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 ]

Author:
Howard Lewis Lewis Ship

Constructor Summary
FieldLabel()
           
 
Method Summary
abstract  java.lang.String getDisplayName()
          displayName parameter
abstract  IFormComponent getField()
          field parameter
abstract  boolean getRaw()
          raw parameter
abstract  boolean isPrerender()
           
protected  void renderComponent(IMarkupWriter writer, IRequestCycle cycle)
          Gets the IForm and delegate, then renders the label obtained from the field.
 
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, getComponent, getComponents, getContainedComponent, getContainer, 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
 
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.hivemind.LocationHolder
setLocation
 
Methods inherited from interface org.apache.hivemind.Locatable
getLocation
 

Constructor Detail

FieldLabel

public FieldLabel()
Method Detail

isPrerender

public abstract boolean isPrerender()

renderComponent

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

Specified by:
renderComponent in class AbstractComponent

getDisplayName

public abstract java.lang.String getDisplayName()
displayName parameter


getField

public abstract IFormComponent getField()
field parameter


getRaw

public abstract boolean getRaw()
raw parameter