Package lumis.doui.render

Class CharSequenceRenderableWrapper

java.lang.Object

lumis.doui.render.CharSequenceRenderableWrapper

All Implemented Interfaces:

java.lang.CharSequence, IRenderable

Direct Known Subclasses:

EmailDataType.Data, LocalizableCharSequenceValue, OptionLookupValue, RenderDataValue

@StableMinor(version="17.0",
             sinceVersion="4.0")
public class CharSequenceRenderableWrapper
extends java.lang.Object
implements java.lang.CharSequence, IRenderable

Wraps a CharSequence and IRenderable instances into an object that implements both interfaces.

Since:

4.0.4

Version:

$Revision$ $Date$

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.CharSequence	charSequence	The wrapped CharSequence object.
protected IRenderable	renderable	The wrapped IRenderable object.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CharSequenceRenderableWrapper(java.lang.CharSequence charSequence)
	CharSequenceRenderableWrapper(java.lang.CharSequence charSequence, IRenderable renderable)

Method Summary

Modifier and Type	Method	Description
char	charAt(int index)
java.lang.String	getDisplayString(IRenderer renderer)	Returns the string to be displayed for representing this instance, when a short display is required.
java.lang.String	getRenderData(IRenderer renderer)	Returns the data of this object in a standard xml format.
int	length()
java.lang.CharSequence	subSequence(int start, int end)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Field Detail

charSequence

protected java.lang.CharSequence charSequence

The wrapped CharSequence object.

Since:

4.0.4

renderable

protected IRenderable renderable

The wrapped IRenderable object.

Since:

4.0.4

Constructor Detail

CharSequenceRenderableWrapper

public CharSequenceRenderableWrapper(java.lang.CharSequence charSequence,
                                     IRenderable renderable)

CharSequenceRenderableWrapper

protected CharSequenceRenderableWrapper(java.lang.CharSequence charSequence)

Method Detail

charAt

public char charAt(int index)

Specified by:

charAt in interface java.lang.CharSequence

length

public int length()

Specified by:

length in interface java.lang.CharSequence

subSequence

public java.lang.CharSequence subSequence(int start,
                                          int end)

Specified by:

subSequence in interface java.lang.CharSequence

toString

public java.lang.String toString()

Specified by:

toString in interface java.lang.CharSequence

Overrides:

toString in class java.lang.Object

getRenderData

public java.lang.String getRenderData(IRenderer renderer)
                               throws PortalException

Description copied from interface: IRenderable

Returns the data of this object in a standard xml format.

Specified by:

getRenderData in interface IRenderable

Parameters:

renderer - the renderer object that will use the returned render data.

Returns:

the xml data for this object.

Throws:

PortalException

getDisplayString

public java.lang.String getDisplayString(IRenderer renderer)
                                  throws PortalException

Description copied from interface: IRenderable

Returns the string to be displayed for representing this instance, when a short display is required.

Specified by:

getDisplayString in interface IRenderable

Parameters:

renderer - the renderer object that will use the returned render data.

Returns:

the string to be used to friendly display this instance.

Throws:

PortalException