org.apache.tapestry.html
Class InsertText

java.lang.Object
  extended by org.apache.tapestry.spec.BaseLocatable
      extended by org.apache.tapestry.AbstractComponent
          extended by org.apache.tapestry.html.InsertText
All Implemented Interfaces:
IComponent, ILocatable, ILocationHolder, IRender

public abstract class InsertText
extends AbstractComponent

Inserts formatted text (possibly collected using a TextArea component. [Component Reference]

To maintain the line breaks provided originally, this component will break the input into individual lines and insert additional HTML to make each line seperate.

This can be down more simply, using the <pre> HTML element, but that usually renders the text in a non-proportional font.

Version:
$Id: InsertText.java 243791 2004-02-19 17:38:13Z hlship $
Author:
Howard Lewis Ship

Constructor Summary
InsertText()
           
 
Method Summary
protected  void finishLoad()
          Sets the mode parameter property to its default, InsertTextMode.BREAK.
abstract  InsertTextMode getMode()
           
abstract  String getValue()
           
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 setMode(InsertTextMode mode)
           
 
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.ILocationHolder
setLocation
 
Methods inherited from interface org.apache.tapestry.ILocatable
getLocation
 

Constructor Detail

InsertText

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

getMode

public abstract InsertTextMode getMode()

setMode

public abstract void setMode(InsertTextMode mode)

getValue

public abstract String getValue()

finishLoad

protected void finishLoad()
Sets the mode parameter property to its default, InsertTextMode.BREAK.

Overrides:
finishLoad in class AbstractComponent
Since:
3.0