|
Jive Forums API (5.5.20.2-oracle) Core Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RenderManager
A manager to manage filters to be used for render operations. This manager contains both adminstrative and user oriented methods; most uses of this manager will use the render methods to render wiki to html, html to wiki, etc as determined by a render context.
Renderer
,
RenderFilter
,
RenderMacro
Method Summary | |
---|---|
void |
addFilterRenderTypes(java.lang.String filterName,
java.util.List renderTypes)
Adds a set of render types for the given filter. |
void |
addRenderFilter(java.lang.String className)
Installs a new class into the list of render filters for the system. |
void |
copyGlobalFilters()
Copy all global filters to the current context. |
long |
getFilterRenderTypes(java.lang.String filterName)
Returns the bitset render types installed for the filter at the given index. |
java.util.Map |
getInheritedRenderFilters()
Retrieve the map of render filters -> renderTypes searching up the tree to the global level if no render filters are defined at the current/parent(s) level. |
RenderFilter |
getRenderFilter(java.lang.String filterName)
Return the render filter with the specified name |
int |
getRenderFilterCount()
Returns the count of currently installed render filters. |
RenderFilter[] |
getRenderFilters()
Returns an array of RenderFilter objects that list all the currently configured render filters. |
void |
removeAllFilters()
Removes all filters from the current context. |
void |
removeFilterRenderTypes(java.lang.String filterName,
java.util.List renderTypes)
Removes a set of render types from the given filter. |
void |
removeRenderFilter(java.lang.String filterName)
Removes the specified filter from the list of currently configured filters. |
java.lang.String |
render(java.lang.Object source,
RenderType renderType,
RenderStrategy strategy,
java.lang.String string)
Applies filters to the specified string. |
java.lang.String |
render(java.lang.Object source,
RenderType renderType,
java.lang.String string)
Applies filters to the specified string. |
void |
save()
Saves all filters to the persistent store. |
Method Detail |
---|
java.lang.String render(java.lang.Object source, RenderType renderType, java.lang.String string)
renderType
will be used to generate the list of filter to apply to the passed in string.
The RenderStrategy.RENDER_ALL
render stategy will be used.
source
- the source object for which we're rendering a string for.renderType
- the render type to use to determine which filters to apply.string
- the string to render.
RenderType
java.lang.String render(java.lang.Object source, RenderType renderType, RenderStrategy strategy, java.lang.String string)
renderType
will be used to the proper list of filters to apply to the passed in string.
source
- the source object for which we're rendering a string for.renderType
- the render type to use to determine which filters to apply.strategy
- the render strategy to use to render the string.string
- the string to render.
RenderType
int getRenderFilterCount() throws UnauthorizedException
UnauthorizedException
- if not an administator.RenderFilter getRenderFilter(java.lang.String filterName) throws UnauthorizedException
filterName
- the name of the filter to return
UnauthorizedException
- if not an administator.RenderFilter[] getRenderFilters() throws UnauthorizedException
UnauthorizedException
- if not a system administator.void addRenderFilter(java.lang.String className) throws UnauthorizedException, java.lang.ClassNotFoundException
className
- the fully qualified name of the class to add to the list of available
render filters in the system.
UnauthorizedException
- if not a system administator.
java.lang.ClassNotFoundException
- if the class could not be loaded.void removeRenderFilter(java.lang.String filterName) throws UnauthorizedException
filterName
- the name of the filter to remove.
UnauthorizedException
- if not an administator.
java.lang.IndexOutOfBoundsException
- if the filterIndex is not valid.long getFilterRenderTypes(java.lang.String filterName) throws UnauthorizedException
filterName
- the name of the filter.
UnauthorizedException
- if not an administator.
java.lang.IndexOutOfBoundsException
- if the filterIndex is not valid.void addFilterRenderTypes(java.lang.String filterName, java.util.List renderTypes) throws UnauthorizedException
filterName
- the name of the filter.renderTypes
- a list of render types to add.
UnauthorizedException
- if not an administator.
java.lang.IndexOutOfBoundsException
- if the filterIndex is not valid.void removeFilterRenderTypes(java.lang.String filterName, java.util.List renderTypes) throws UnauthorizedException
filterName
- the name of the filter.renderTypes
- a list of render types to remove.
UnauthorizedException
- if not an administator.
java.lang.IndexOutOfBoundsException
- if the filterIndex is not valid.void save() throws UnauthorizedException
Warning: Calling this method will expire all pertinent caches so that cache consistency is maintained.
UnauthorizedException
- if not a system administator.java.util.Map getInheritedRenderFilters()
void copyGlobalFilters() throws java.lang.IllegalStateException, UnauthorizedException
java.lang.IllegalStateException
- if the current context already has 1 or more filters configured
UnauthorizedException
- if not an adminvoid removeAllFilters() throws UnauthorizedException
UnauthorizedException
- if not an admin
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |