lumis.doui.render
Class RenderDataValue

Package class diagram package RenderDataValue
java.lang.Object
  extended by lumis.doui.render.CharSequenceRenderableWrapper
      extended by lumis.doui.render.RenderDataValue
All Implemented Interfaces:
CharSequence, IRenderable

@StableMinor(version="4.1",
             sinceVersion="4.0")
public class RenderDataValue
extends CharSequenceRenderableWrapper

Allows a CharSequence value to be used directly as the render data.

Since:
4.0.10

Field Summary
 
Fields inherited from class lumis.doui.render.CharSequenceRenderableWrapper
charSequence, renderable
 
Constructor Summary
RenderDataValue(CharSequence value)
          Creates a new RenderDataValue that uses the given CharSequence as getDisplayString(IRenderer) and getRenderData(IRenderer).
 
Method Summary
 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.
 
Methods inherited from class lumis.doui.render.CharSequenceRenderableWrapper
charAt, length, subSequence, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RenderDataValue

public RenderDataValue(CharSequence value)
Creates a new RenderDataValue that uses the given CharSequence as getDisplayString(IRenderer) and getRenderData(IRenderer). If the given value is null, an empty string will be used instead.

Parameters:
value - the string.
Since:
4.0.10
Method Detail

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
Overrides:
getRenderData in class CharSequenceRenderableWrapper
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
Overrides:
getDisplayString in class CharSequenceRenderableWrapper
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


Lumisportal  4.1.0.071221 - Copyright © 2001-2007, Lumis. All Rights Reserved.