ForumsBean (Alfresco 5.3.a-SNAPSHOT API)

java.lang.Object
- org.alfresco.web.bean.forums.ForumsBean

All Implemented Interfaces:

Serializable, IContextListener
```
public class ForumsBean
extends Object
implements IContextListener
```
Bean providing properties and behaviour for the forums screens.

Author:

gavinc

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ForumsBean.TopicBubbleViewRenderer
Class to implement a bubble view for the RichList component used in the topics screen

Nested Classes
Modifier and Type	Class and Description
`static class`	`ForumsBean.TopicBubbleViewRenderer` Class to implement a bubble view for the RichList component used in the topics screen

Field Summary

Fields
Modifier and Type	Field and Description
`protected BrowseBean`	`browseBean` The browse bean
`protected UIRichList`	`forumRichList`
`protected UIRichList`	`forumsRichList` Component references
`protected NavigationBean`	`navigator` The NavigationBean bean reference
`NodePropertyResolver`	`resolverContent`
`NodePropertyResolver`	`resolverReplies`
`NodePropertyResolver`	`resolverReplyTo`
`protected UIRichList`	`topicRichList`
`protected ViewsConfigElement`	`viewsConfig` Views configuration object

Constructor Summary

Constructors
Constructor and Description

ForumsBean()
Default Constructor

Constructors
Constructor and Description
`ForumsBean()` Default Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`areaChanged()` Method called by UIContextService.areaChanged() to inform all registered beans that the user has changed area i.e.
`void`	`contextUpdated()` Method called by UIContextService.notifyBeans() to inform all registered beans that all UI Beans should refresh dump all cached data and settings.
`static String`	`createPostFileName()` Creates a file name for the message being posted
`void`	`discuss(ActionEvent event)` Event handler called when a user wants to view or participate in a discussion on an object
`void`	`forumsViewModeChanged(ActionEvent event)` Change the current forums view mode based on user selection
`void`	`forumViewModeChanged(ActionEvent event)` Change the current forum view mode based on user selection
`protected ContentService`	`getContentService()`
`protected org.alfresco.service.cmr.dictionary.DictionaryService`	`getDictionaryService()`
`int`	`getForumPageSize()`
`UIRichList`	`getForumRichList()`
`List<Node>`	`getForums()`
`int`	`getForumsPageSize()`
`UIRichList`	`getForumsRichList()`
`String`	`getForumsViewMode()`
`String`	`getForumViewMode()`
`protected org.alfresco.service.namespace.NamespaceService`	`getNamespaceService()`
`protected org.alfresco.service.cmr.repository.NodeService`	`getNodeService()`
`List<Node>`	`getPosts()`
`String`	`getReplyBubbleHTML()` Returns the HTML to represent a bubble rendition of the text of the the forum article being replied to.
`protected org.alfresco.service.cmr.search.SearchService`	`getSearchService()`
`int`	`getTopicPageSize()`
`UIRichList`	`getTopicRichList()`
`List<Node>`	`getTopics()`
`String`	`getTopicViewMode()`
`protected void`	`renderReplyContentHTML(FacesContext context, Node replyToNode, StringWriter writer, String contextPath, String colour, String bgColour)`
`void`	`setBrowseBean(BrowseBean browseBean)` Sets the BrowseBean instance to use to retrieve the current document
`void`	`setContentService(ContentService contentService)` Sets the content service to use
`void`	`setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)`
`void`	`setForumPageSize(int forumPageSize)`
`void`	`setForumRichList(UIRichList forumRichList)`
`void`	`setForumsPageSize(int forumsPageSize)`
`void`	`setForumsRichList(UIRichList forumsRichList)`
`void`	`setForumsViewMode(String forumsViewMode)`
`void`	`setForumViewMode(String forumViewMode)`
`void`	`setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)`
`void`	`setNavigator(NavigationBean navigator)`
`void`	`setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)`
`void`	`setSearchService(org.alfresco.service.cmr.search.SearchService searchService)`
`void`	`setTopicPageSize(int topicPageSize)`
`void`	`setTopicRichList(UIRichList topicRichList)`
`void`	`setTopicViewMode(String topicViewMode)`
`void`	`spaceChanged()` Method called by UIContextService.spaceChanged() to inform all registered beans that the current space has changed.
`void`	`topicViewModeChanged(ActionEvent event)` Change the current topic view mode based on user selection

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - browseBean
```
protected BrowseBean browseBean
```
    The browse bean
  - navigator
```
protected NavigationBean navigator
```
    The NavigationBean bean reference
  - viewsConfig
```
protected ViewsConfigElement viewsConfig
```
    Views configuration object
  - forumsRichList
```
protected UIRichList forumsRichList
```
    Component references
  - forumRichList
```
protected UIRichList forumRichList
```
  - topicRichList
```
protected UIRichList topicRichList
```
  - resolverReplies
```
public NodePropertyResolver resolverReplies
```
  - resolverContent
```
public NodePropertyResolver resolverContent
```
  - resolverReplyTo
```
public NodePropertyResolver resolverReplyTo
```
- Constructor Detail
  - ForumsBean
```
public ForumsBean()
```
    Default Constructor
- Method Detail
  - setNodeService
```
public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
```
    Parameters:
    
    nodeService - The NodeService to set.
  - getNodeService
```
protected org.alfresco.service.cmr.repository.NodeService getNodeService()
```
  - setContentService
```
public void setContentService(ContentService contentService)
```
    Sets the content service to use
    
    Parameters:
    
    contentService - The ContentService
  - getContentService
```
protected ContentService getContentService()
```
  - setDictionaryService
```
public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
```
    Parameters:
    
    dictionaryService - The DictionaryService to set.
  - getDictionaryService
```
protected org.alfresco.service.cmr.dictionary.DictionaryService getDictionaryService()
```
  - setSearchService
```
public void setSearchService(org.alfresco.service.cmr.search.SearchService searchService)
```
    Parameters:
    
    searchService - The SearchService to set.
  - getSearchService
```
protected org.alfresco.service.cmr.search.SearchService getSearchService()
```
  - setNamespaceService
```
public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
```
    Parameters:
    
    namespaceService - The NamespaceService to set.
  - getNamespaceService
```
protected org.alfresco.service.namespace.NamespaceService getNamespaceService()
```
  - setBrowseBean
```
public void setBrowseBean(BrowseBean browseBean)
```
    Sets the BrowseBean instance to use to retrieve the current document
    
    Parameters:
    
    browseBean - BrowseBean instance
  - setNavigator
```
public void setNavigator(NavigationBean navigator)
```
    Parameters:
    
    navigator - The NavigationBean to set.
  - setForumsRichList
```
public void setForumsRichList(UIRichList forumsRichList)
```
    Parameters:
    
    forumsRichList - The forumsRichList to set.
  - getForumsRichList
```
public UIRichList getForumsRichList()
```
    Returns:
    
    Returns the forumsRichList.
  - getForumsViewMode
```
public String getForumsViewMode()
```
    Returns:
    
    Returns the forums View mode. See UIRichList
  - setForumsViewMode
```
public void setForumsViewMode(String forumsViewMode)
```
    Parameters:
    
    forumsViewMode - The forums View mode to set. See UIRichList.
  - getForumsPageSize
```
public int getForumsPageSize()
```
    Returns:
    
    Returns the forumsPageSize.
  - setForumsPageSize
```
public void setForumsPageSize(int forumsPageSize)
```
    Parameters:
    
    forumsPageSize - The forumsPageSize to set.
  - setTopicRichList
```
public void setTopicRichList(UIRichList topicRichList)
```
    Parameters:
    
    topicRichList - The topicRichList to set.
  - getTopicRichList
```
public UIRichList getTopicRichList()
```
    Returns:
    
    Returns the topicRichList.
  - getTopicViewMode
```
public String getTopicViewMode()
```
    Returns:
    
    Returns the topics View mode. See UIRichList
  - setTopicViewMode
```
public void setTopicViewMode(String topicViewMode)
```
    Parameters:
    
    topicViewMode - The topic View mode to set. See UIRichList.
  - getTopicPageSize
```
public int getTopicPageSize()
```
    Returns:
    
    Returns the topicsPageSize.
  - setTopicPageSize
```
public void setTopicPageSize(int topicPageSize)
```
    Parameters:
    
    topicPageSize - The topicPageSize to set.
  - setForumRichList
```
public void setForumRichList(UIRichList forumRichList)
```
    Parameters:
    
    forumRichList - The forumRichList to set.
  - getForumRichList
```
public UIRichList getForumRichList()
```
    Returns:
    
    Returns the forumRichList.
  - getForumViewMode
```
public String getForumViewMode()
```
    Returns:
    
    Returns the forum View mode. See UIRichList
  - setForumViewMode
```
public void setForumViewMode(String forumViewMode)
```
    Parameters:
    
    forumViewMode - The forum View mode to set. See UIRichList.
  - getForumPageSize
```
public int getForumPageSize()
```
    Returns:
    
    Returns the forumPageSize.
  - setForumPageSize
```
public void setForumPageSize(int forumPageSize)
```
    Parameters:
    
    forumPageSize - The forumPageSize to set.
  - getForums
```
public List<Node> getForums()
```
  - getTopics
```
public List<Node> getTopics()
```
  - getPosts
```
public List<Node> getPosts()
```
  - getReplyBubbleHTML
```
public String getReplyBubbleHTML()
```
    Returns the HTML to represent a bubble rendition of the text of the the forum article being replied to.
    
    Returns:
    
    The HTML for the bubble
  - contextUpdated
```
public void contextUpdated()
```
    Description copied from interface: IContextListener
    
    Method called by UIContextService.notifyBeans() to inform all registered beans that all UI Beans should refresh dump all cached data and settings.
    
    Specified by:
    
    contextUpdated in interface IContextListener
    
    See Also:
    
    IContextListener.contextUpdated()
  - areaChanged
```
public void areaChanged()
```
    Description copied from interface: IContextListener
    
    Method called by UIContextService.areaChanged() to inform all registered beans that the user has changed area i.e. from company home to my home.
    
    Specified by:
    
    areaChanged in interface IContextListener
    
    See Also:
    
    IContextListener.areaChanged()
  - spaceChanged
```
public void spaceChanged()
```
    Description copied from interface: IContextListener
    
    Method called by UIContextService.spaceChanged() to inform all registered beans that the current space has changed.
    
    Specified by:
    
    spaceChanged in interface IContextListener
    
    See Also:
    
    IContextListener.spaceChanged()
  - forumsViewModeChanged
```
public void forumsViewModeChanged(ActionEvent event)
```
    Change the current forums view mode based on user selection
    
    Parameters:
    
    event - ActionEvent
  - forumViewModeChanged
```
public void forumViewModeChanged(ActionEvent event)
```
    Change the current forum view mode based on user selection
    
    Parameters:
    
    event - ActionEvent
  - topicViewModeChanged
```
public void topicViewModeChanged(ActionEvent event)
```
    Change the current topic view mode based on user selection
    
    Parameters:
    
    event - ActionEvent
  - discuss
```
public void discuss(ActionEvent event)
```
    Event handler called when a user wants to view or participate in a discussion on an object
    
    Parameters:
    
    event - ActionEvent
  - createPostFileName
```
public static String createPostFileName()
```
    Creates a file name for the message being posted
    
    Returns:
    
    The file name for the post
  - renderReplyContentHTML
```
protected void renderReplyContentHTML(FacesContext context,
                                      Node replyToNode,
                                      StringWriter writer,
                                      String contextPath,
                                      String colour,
                                      String bgColour)
                               throws IOException
```
    Throws:
    
    IOException

Class ForumsBean

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

browseBean

navigator

viewsConfig

forumsRichList

forumRichList

topicRichList

resolverReplies

resolverContent

resolverReplyTo

Constructor Detail

ForumsBean

Method Detail

setNodeService

getNodeService

setContentService

getContentService

setDictionaryService

getDictionaryService

setSearchService

getSearchService

setNamespaceService

getNamespaceService

setBrowseBean

setNavigator

setForumsRichList

getForumsRichList

getForumsViewMode

setForumsViewMode

getForumsPageSize

setForumsPageSize

setTopicRichList

getTopicRichList

getTopicViewMode

setTopicViewMode

getTopicPageSize

setTopicPageSize

setForumRichList

getForumRichList

getForumViewMode

setForumViewMode

getForumPageSize

setForumPageSize

getForums

getTopics

getPosts

getReplyBubbleHTML

contextUpdated

areaChanged

spaceChanged

forumsViewModeChanged

forumViewModeChanged

topicViewModeChanged

discuss

createPostFileName

renderReplyContentHTML