lumis.doui.render
Class CharSequenceRenderableWrapper

java.lang.Object
  lumis.doui.render.CharSequenceRenderableWrapper

All Implemented Interfaces:

CharSequence, IRenderable

Direct Known Subclasses:

LocalizableCharSequenceValue, OptionLookupValue, RenderDataValue

@StableMinor(version="5.5",
             sinceVersion="4.0")
public class CharSequenceRenderableWrapper
extends Object
implements CharSequence, IRenderable

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

Since:

4.0.4

Field Summary

protected CharSequence	charSequence The wrapped CharSequence object.
protected IRenderable	renderable The wrapped IRenderable object.

Constructor Summary

protected	CharSequenceRenderableWrapper(CharSequence charSequence)
	CharSequenceRenderableWrapper(CharSequence charSequence, IRenderable renderable)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

charSequence

protected 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(CharSequence charSequence,
                                     IRenderable renderable)

CharSequenceRenderableWrapper

protected CharSequenceRenderableWrapper(CharSequence charSequence)

Method Detail

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

length

public int length()

Specified by:

length in interface CharSequence

subSequence

public CharSequence subSequence(int start,
                                int end)

Specified by:

subSequence in interface CharSequence

toString

public String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

getRenderData

public 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 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