IRenderable

All Known Implementing Classes:

CategorizationDataType.Data, ChannelDataType.Data, CharSequenceRenderableWrapper, DateDataType.Data, DateTimeDataType.Data, DocumentDataType.Data, EmailDataType.Data, FileDataType.Data, FilesDataType.Data, HtmlDataType.Data, ImageDataType.Data, LocaleMetaDataDataType.Data, LocalizableCharSequenceValue, MediaDataType.Data, OptionLookupValue, PageDataType.Data, PrincipalDataType.Data, RenderDataValue, ResourcesDataType.Data, TagDataType.Data, TimeDataType.Data, WorkflowStateDataType.Data
```
@StableMinor(version="16.1",
             sinceVersion="4.0")
public interface IRenderable
```
Classes that implements this interface offers a standard way to render its data in a xml format.

Since:

4.0.4

Version:

$Revision: 26157 $ $Date: 2024-01-13 11:35:03 -0300 (Sat, 13 Jan 2024) $

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`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.

- Method Detail
  - getRenderData
```
java.lang.String getRenderData(IRenderer renderer)
                        throws PortalException
```
    Returns the data of this object in a standard xml format.
    
    Parameters:
    
    renderer - the renderer object that will use the returned render data.
    
    Returns:
    
    the xml data for this object.
    
    Throws:
    
    PortalException
    
    Since:
    
    4.0.4
  - getDisplayString
```
java.lang.String getDisplayString(IRenderer renderer)
                           throws PortalException
```
    Returns the string to be displayed for representing this instance, when a short display is required.
    
    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
    
    Since:
    
    4.0.5