org.apache.tapestry.html

Class InsertText

java.lang.Object

org.apache.hivemind.impl.BaseLocatable

org.apache.tapestry.AbstractComponent

org.apache.tapestry.html.InsertText

All Implemented Interfaces:

org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, IComponent, 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.

Author:

Howard Lewis Ship

Constructor Summary

Constructors

Constructor and Description
InsertText()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	finishLoad() Sets the mode parameter property to its default, InsertTextMode.BREAK.
abstract InsertTextMode	getMode() Parameter
abstract boolean	getRaw() Parameter
abstract java.lang.String	getValue() Parameter
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, checkActiveLock, cleanupAfterRender, enterActiveState, 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

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

Parameter

setMode

public abstract void setMode(InsertTextMode mode)

getValue

public abstract java.lang.String getValue()

Parameter

getRaw

public abstract boolean getRaw()

Parameter

finishLoad

protected void finishLoad()

Sets the mode parameter property to its default, InsertTextMode.BREAK.

Overrides:

finishLoad in class AbstractComponent

Since:

3.0