Clearspace API (1.7.0) Core Javadocs

Package com.jivesoftware.community.renderer

The renderer package provides a way for converting text in one format into another, typically from markup to html and vice versa.

See:
          Description

Interface Summary
RenderContext Encapsulates the context in which a piece of content is being rendered.
Renderer A Renderer is an object that allows for converting text markup to html and back again.
RenderFilter A filter is an object that performs filtering on Strings.
RenderMacro The RenderMacro interface is an extension to the RenderFilter interface, the main difference being that it will not execute over the whole page, rather it will be provided with just the text between the macro tags, if it exists.
RenderManager A manager to manage filters to be used for render operations.
 

Class Summary
AbstractRenderFilter An abstract implementation of the RenderFilter interface this class provides subclasses with built in support for documentation and splits apart the execute method into seperate methods depending on the render target specified in the render context.
BaseFilter A Base class to be used to create a filter.
BaseMacro A Base class to be used to create macros.
RenderedTextStore A store for text snippets.
RendererFactory A factory for creating Renderer's.
RenderPipe A container to hold the filters that are to be used for rendering text.
RenderStrategy A RenderStrategy allows for the coarse grained ability to determine what will be rendered by a particular render call irregardless of what filters are included.
 

Enum Summary
RenderTarget The target of a particular render operation.
RenderType Defines render types used for jive objects.
 

Package com.jivesoftware.community.renderer Description

The renderer package provides a way for converting text in one format into another, typically from markup to html and vice versa.


Clearspace Project Page

Copyright © 1999-2007 Jive Software.