|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.renderer.impl.JiveRenderManager
public class JiveRenderManager
Default implementation of the RenderManager interface.
Field Summary | |
---|---|
static java.lang.String[] |
DEFAULT_FILTER_CLASSES
|
static long[] |
DEFAULT_FILTER_RENDER_TYPES
|
protected static java.util.Map |
inheritedFilters
|
Constructor Summary | |
---|---|
JiveRenderManager(DbForumFactory factory,
int objectType,
long objectID)
Creates a new render manager. |
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 |
categoryAdded(CategoryEvent event)
Fired when a category has been added to the system. |
void |
categoryDeleted(CategoryEvent event)
Fired when a category is about to be deleted from the system. |
void |
categoryModified(CategoryEvent event)
Fired when a category has been modified. |
void |
categoryMoved(CategoryEvent event)
Fired when a category has been moved from one category to another. |
void |
copyGlobalFilters()
Copy all global filters to the current context. |
void |
destroy()
Notifies the manager to release any resources that may be holding on too. |
void |
forumAdded(ForumEvent event)
Fired when a forum has been added to the system. |
void |
forumDeleted(ForumEvent event)
Fired when a forum is about to be deleted from the system. |
void |
forumMerged(ForumEvent event)
Fired when a forum is merged into another forum. |
void |
forumModified(ForumEvent event)
Fired when a forum is modified. |
void |
forumMoved(ForumEvent event)
Fired when a forum has been moved from one category to another. |
static JiveRenderManager |
getCategoryRenderManager(long categoryID)
|
static RenderFilter[] |
getDefaultFilterList(RenderType renderType)
Returns an array of default filters in the system. |
long |
getFilterRenderTypes(java.lang.String filterName)
Returns the bitset render types installed for the filter at the given index. |
static JiveRenderManager |
getForumRenderManager(long forumID)
|
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. |
java.util.List |
getInheritedRenderFilters(RenderType renderType)
Retrieve the array of render filters for the given render type 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. |
java.util.List |
getTags()
|
void |
initialize()
Initialize the manager. |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String[] DEFAULT_FILTER_CLASSES
public static final long[] DEFAULT_FILTER_RENDER_TYPES
protected static java.util.Map inheritedFilters
Constructor Detail |
---|
public JiveRenderManager(DbForumFactory factory, int objectType, long objectID)
factory
- the forum factoryobjectType
- the type of object to create a render manager forobjectID
- the object ID of the object to create a render manager forMethod Detail |
---|
public void initialize()
JiveManager
This method is used internally by Jive during application startup and should not be called during normal usage of the class.
initialize
in interface JiveManager
public void destroy()
JiveManager
destroy
in interface JiveManager
public java.lang.String render(java.lang.Object source, RenderType renderType, java.lang.String string)
RenderManager
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.
render
in interface RenderManager
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
public java.lang.String render(java.lang.Object source, RenderType renderType, RenderStrategy strategy, java.lang.String string)
RenderManager
renderType
will be used to the proper list of filters to apply to the passed in string.
render
in interface RenderManager
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
public int getRenderFilterCount()
RenderManager
getRenderFilterCount
in interface RenderManager
public RenderFilter getRenderFilter(java.lang.String filterName)
RenderManager
getRenderFilter
in interface RenderManager
filterName
- the name of the filter to return
public RenderFilter[] getRenderFilters()
RenderManager
getRenderFilters
in interface RenderManager
public static RenderFilter[] getDefaultFilterList(RenderType renderType)
renderType
- a render type to use to narrow down the default filter list
public java.util.Map getInheritedRenderFilters()
getInheritedRenderFilters
in interface RenderManager
public java.util.List getInheritedRenderFilters(RenderType renderType)
renderType
- the render type
public void addRenderFilter(java.lang.String className) throws java.lang.ClassNotFoundException, java.lang.IllegalArgumentException
RenderManager
addRenderFilter
in interface RenderManager
className
- the fully qualified name of the class to add to the list of available
render filters in the system.
java.lang.ClassNotFoundException
- if the class could not be loaded.
java.lang.IllegalArgumentException
public void removeRenderFilter(java.lang.String filterName)
RenderManager
removeRenderFilter
in interface RenderManager
filterName
- the name of the filter to remove.public long getFilterRenderTypes(java.lang.String filterName)
RenderManager
getFilterRenderTypes
in interface RenderManager
filterName
- the name of the filter.
public void addFilterRenderTypes(java.lang.String filterName, java.util.List renderTypes)
RenderManager
addFilterRenderTypes
in interface RenderManager
filterName
- the name of the filter.renderTypes
- a list of render types to add.public void removeFilterRenderTypes(java.lang.String filterName, java.util.List renderTypes)
RenderManager
removeFilterRenderTypes
in interface RenderManager
filterName
- the name of the filter.renderTypes
- a list of render types to remove.public void save()
RenderManager
Warning: Calling this method will expire all pertinent caches so that cache consistency is maintained.
save
in interface RenderManager
public static JiveRenderManager getCategoryRenderManager(long categoryID)
public static JiveRenderManager getForumRenderManager(long forumID)
public void copyGlobalFilters() throws java.lang.IllegalStateException, UnauthorizedException
ForumRenderManager
copyGlobalFilters
in interface ForumRenderManager
copyGlobalFilters
in interface RenderManager
java.lang.IllegalStateException
- if the current context already has 1 or more filters configured
UnauthorizedException
- if not an adminpublic void removeAllFilters() throws UnauthorizedException
ForumRenderManager
removeAllFilters
in interface ForumRenderManager
removeAllFilters
in interface RenderManager
UnauthorizedException
- if not an adminpublic java.util.List getTags()
public void categoryAdded(CategoryEvent event)
CategoryListener
categoryAdded
in interface CategoryListener
event
- the event object.public void categoryDeleted(CategoryEvent event)
CategoryListener
categoryDeleted
in interface CategoryListener
event
- the event object.public void categoryModified(CategoryEvent event)
CategoryListener
categoryModified
in interface CategoryListener
event
- the event object.public void categoryMoved(CategoryEvent event)
CategoryListener
categoryMoved
in interface CategoryListener
event
- the event object.public void forumAdded(ForumEvent event)
ForumListener
forumAdded
in interface ForumListener
event
- the event object.public void forumDeleted(ForumEvent event)
ForumListener
forumDeleted
in interface ForumListener
event
- the event object.public void forumModified(ForumEvent event)
ForumListener
forumModified
in interface ForumListener
event
- the event object.public void forumMoved(ForumEvent event)
ForumListener
forumMoved
in interface ForumListener
event
- the event object.public void forumMerged(ForumEvent event)
ForumListener
forumMerged
in interface ForumListener
event
- the event object.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |