com.jivesoftware.forum.theme
Class ForumThemeManager

java.lang.Object
  com.jivesoftware.base.theme.AbstractThemeManager
      com.jivesoftware.forum.theme.ForumThemeManager

All Implemented Interfaces:

ThemeManager, CategoryListener, ForumListener

public class ForumThemeManager
extends AbstractThemeManager
implements ForumListener, CategoryListener

Adds additional features to manage themes for the forums application, including binding themes to categories and forums.

Nested Class Summary

Nested classes/interfaces inherited from class com.jivesoftware.base.theme.AbstractThemeManager

AbstractThemeManager.ThemePutTask, AbstractThemeManager.ThemeRemoveTask

Field Summary

static java.lang.String

THEME_KEY

Fields inherited from class com.jivesoftware.base.theme.AbstractThemeManager

globalTheme, THEME_CONFIG_FILENAME, themeMaps, themes, themesDir

Constructor Summary

ForumThemeManager()

Method Summary

void	addThemeMap(java.lang.String theme, ThemeMap themeMap) Adds a theme mapping to 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.
Theme	determineTheme(com.opensymphony.xwork.ActionContext ac, javax.servlet.http.HttpServletRequest request) Returns the Theme corresponding to the given parameters, or null if no theme meets the criteria.
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.
protected boolean	isNumValue(ThemeMap themeMap) Returns true if the themeMap is using a number value, false if it's using a string value.

Methods inherited from class com.jivesoftware.base.theme.AbstractThemeManager

deleteThemeMap, getGlobalTheme, getTheme, getTheme, getTheme, getThemeByName, getThemeHome, getThemeMaps, getThemes, reloadThemeMaps

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

THEME_KEY

public static final java.lang.String THEME_KEY

See Also:

Constant Field Values

Constructor Detail

ForumThemeManager

public ForumThemeManager()

Method Detail

addThemeMap

public void addThemeMap(java.lang.String theme,
                        ThemeMap themeMap)

Description copied from interface: ThemeManager

Adds a theme mapping to the system.

Specified by:

addThemeMap in interface ThemeManager

Overrides:

addThemeMap in class AbstractThemeManager

Parameters:

theme - the name of the theme

themeMap - the ThemeMap containing the criteria used to determine when to use the theme

determineTheme

public Theme determineTheme(com.opensymphony.xwork.ActionContext ac,
                            javax.servlet.http.HttpServletRequest request)

Description copied from interface: ThemeManager

Returns the Theme corresponding to the given parameters, or null if no theme meets the criteria.

Specified by:

determineTheme in interface ThemeManager

Specified by:

determineTheme in class AbstractThemeManager

Parameters:

ac - the action context

request - the servlet request

Returns:

the Theme corresponding to the given parameters, or null if no theme meets the criteria

See Also:

Theme

isNumValue

protected boolean isNumValue(ThemeMap themeMap)

Description copied from class: AbstractThemeManager

Returns true if the themeMap is using a number value, false if it's using a string value.

Specified by:

isNumValue in class AbstractThemeManager

Parameters:

themeMap - the ThemeMap to check the value for

Returns:

true if the themeMap is using a number value, false if it's using a string value.

forumAdded

public void forumAdded(ForumEvent event)

Description copied from interface: ForumListener

Fired when a forum has been added to the system.

Specified by:

forumAdded in interface ForumListener

Parameters:

event - the event object.

forumDeleted

public void forumDeleted(ForumEvent event)

Description copied from interface: ForumListener

Fired when a forum is about to be deleted from the system. This event will be fired when an individual forum is deleted or when the forum's category is deleted. Because various code pieces may depend on this event for performing cleanup tasks, it's guaranteed that this method will be called before the forum is deleted from the database.

Specified by:

forumDeleted in interface ForumListener

Parameters:

event - the event object.

forumMoved

public void forumMoved(ForumEvent event)

Description copied from interface: ForumListener

Fired when a forum has been moved from one category to another.

Specified by:

forumMoved in interface ForumListener

Parameters:

event - the event object.

forumModified

public void forumModified(ForumEvent event)

Description copied from interface: ForumListener

Fired when a forum is modified.

Specified by:

forumModified in interface ForumListener

Parameters:

event - the event object.

forumMerged

public void forumMerged(ForumEvent event)

Description copied from interface: ForumListener

Fired when a forum is merged into another forum.

Specified by:

forumMerged in interface ForumListener

Parameters:

event - the event object.

categoryAdded

public void categoryAdded(CategoryEvent event)

Description copied from interface: CategoryListener

Fired when a category has been added to the system.

Specified by:

categoryAdded in interface CategoryListener

Parameters:

event - the event object.

categoryDeleted

public void categoryDeleted(CategoryEvent event)

Description copied from interface: CategoryListener

Fired when a category is about to be deleted from the system. Because various code pieces may depend on this event for performing cleanup tasks, it's guaranteed that this method will be called before the category is deleted from the database.

Specified by:

categoryDeleted in interface CategoryListener

Parameters:

event - the event object.

categoryMoved

public void categoryMoved(CategoryEvent event)

Description copied from interface: CategoryListener

Fired when a category has been moved from one category to another.

Specified by:

categoryMoved in interface CategoryListener

Parameters:

event - the event object.

categoryModified

public void categoryModified(CategoryEvent event)

Description copied from interface: CategoryListener

Fired when a category has been modified.

Specified by:

categoryModified in interface CategoryListener

Parameters:

event - the event object.