org.nuxeo.ecm.platform.comment.web

Class AbstractCommentManagerActionsBean

java.lang.Object

org.nuxeo.ecm.platform.comment.web.AbstractCommentManagerActionsBean

All Implemented Interfaces:

CommentManagerActions

Direct Known Subclasses:

CommentManagerActionsBean

public abstract class AbstractCommentManagerActionsBean
extends Object
implements CommentManagerActions

Author:

George Lefter

Field Summary

Fields

Modifier and Type	Field and Description
protected CommentableDocument	commentableDoc
protected Map<String,UIComment>	commentMap
protected static String	COMMENTS_ACTIONS
protected boolean	commentStarted
protected List<ThreadEntry>	commentThread
protected String	deleteCommentId
protected CoreSession	documentManager
protected List<UIComment>	flatComments
protected NavigationContext	navigationContext
protected String	newContent
protected NuxeoPrincipal	principal
protected boolean	principalIsAdmin
protected String	replyCommentId
protected String	savedReplyCommentId
protected boolean	showCreateForm
protected List<UIComment>	uiComments
protected UserSession	userSession
protected WebActions	webActions

Fields inherited from interface org.nuxeo.ecm.platform.comment.web.CommentManagerActions

CHILDREN_COMMENT_LIST

Constructor Summary

Constructors

Constructor and Description
AbstractCommentManagerActionsBean()

Method Summary

Modifier and Type	Method and Description
String	addComment() creates a new comment from
DocumentModel	addComment(DocumentModel comment) Add the given comment DocumentModel to commentableDoc.
DocumentModel	addComment(DocumentModel comment, DocumentModel docToComment)
String	beginComment()
String	cancelComment()
void	cleanContextVariable()
String	createComment(DocumentModel docToComment) Same as addComment() method but using the given document instead of currentDocument.
protected UIComment	createUIComment(UIComment parent, DocumentModel comment) Creates a UIComment wrapping "comment", having "parent" as parent.
String	deleteComment()
String	deleteComment(String commentId)
void	destroy()
void	documentChanged() Clean all the bean's context variables.
void	flattenTree(List<ThreadEntry> commentThread, UIComment uiComment, int depth) Visits a list of comment trees and puts them into a list of "ThreadEntry"s.
List<Action>	getActionsForComment()
List<Action>	getActionsForComment(String category)
void	getChildren(UIComment comment) Retrieves children for a given comment.
protected CommentableDocument	getCommentableDoc()
protected CommentableDocument	getCommentableDoc(DocumentModel doc)
List<UIComment>	getComments(DocumentModel doc)
List<ThreadEntry>	getCommentsAsThread(DocumentModel commentedDoc) Initialize uiComments with given Document if uiComments is null.
List<ThreadEntry>	getCommentsAsThreadOnDoc(DocumentModel doc) Recursively retrieves all comments of a doc.
boolean	getCommentStarted()
List<UIComment>	getLastCommentsByDate(String commentNumber) Retrieves a given number of comments from currentDocument.
List<UIComment>	getLastCommentsByDate(String commentNumber, DocumentModel commentedDoc) Retrieves a given number of comments from the given Document.
String	getNewContent()
boolean	getPrincipalIsAdmin()
String	getPrincipalName()
String	getSavedReplyCommentId()
boolean	getShowCreateForm()
void	initComments() Initializes uiComments with Comments of current document.
void	initComments(DocumentModel commentedDoc) Initializes uiComments with Comments of current document.
void	initialize() Bean initialization method.
protected DocumentModel	initializeComment(DocumentModel comment)
void	setNewContent(String newContent)
void	setSavedReplyCommentId(String savedReplyCommentId)
void	setShowCreateForm(boolean flag)
void	toggleCreateForm(javax.faces.event.ActionEvent event)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.platform.comment.web.CommentManagerActions

getCommentsAsThread

Field Detail

COMMENTS_ACTIONS

protected static final String COMMENTS_ACTIONS

See Also:

Constant Field Values

principal

protected NuxeoPrincipal principal

principalIsAdmin

protected boolean principalIsAdmin

showCreateForm

protected boolean showCreateForm

documentManager

@In(create=true,
    required=false)
protected transient CoreSession documentManager

webActions

@In(create=true)
protected transient WebActions webActions

newContent

protected String newContent

commentableDoc

protected CommentableDocument commentableDoc

uiComments

protected List<UIComment> uiComments

commentThread

protected List<ThreadEntry> commentThread

deleteCommentId

@RequestParameter
protected String deleteCommentId

replyCommentId

@RequestParameter
protected String replyCommentId

savedReplyCommentId

protected String savedReplyCommentId

commentMap

protected Map<String,UIComment> commentMap

commentStarted

protected boolean commentStarted

flatComments

protected List<UIComment> flatComments

userSession

@In(create=true)
protected UserSession userSession

navigationContext

@In(create=true)
protected NavigationContext navigationContext

Constructor Detail

AbstractCommentManagerActionsBean

public AbstractCommentManagerActionsBean()

Method Detail

initialize

@Create
public void initialize()

Description copied from interface: CommentManagerActions

Bean initialization method.

Specified by:

initialize in interface CommentManagerActions

destroy

@Destroy
public void destroy()

Specified by:

destroy in interface CommentManagerActions

getPrincipalName

public String getPrincipalName()

Specified by:

getPrincipalName in interface CommentManagerActions

getPrincipalIsAdmin

public boolean getPrincipalIsAdmin()

Specified by:

getPrincipalIsAdmin in interface CommentManagerActions

initializeComment

protected DocumentModel initializeComment(DocumentModel comment)

addComment

public DocumentModel addComment(DocumentModel comment,
                                DocumentModel docToComment)

addComment

public DocumentModel addComment(DocumentModel comment)

Description copied from interface: CommentManagerActions

Add the given comment DocumentModel to commentableDoc.

Specified by:

addComment in interface CommentManagerActions

addComment

public String addComment()

Description copied from interface: CommentManagerActions

creates a new comment from

Specified by:

addComment in interface CommentManagerActions

Returns:

null to avoid navigation

createComment

public String createComment(DocumentModel docToComment)

Description copied from interface: CommentManagerActions

Same as addComment() method but using the given document instead of currentDocument.

Specified by:

createComment in interface CommentManagerActions

Returns:

null to avoid navigation

documentChanged

@Observer(value={"documentSelectionChanged","contentRootSelectionChanged","documentChanged"},
          create=false)
 @BypassInterceptors
public void documentChanged()

Description copied from interface: CommentManagerActions

Clean all the bean's context variables.

Specified by:

documentChanged in interface CommentManagerActions

getCommentableDoc

protected CommentableDocument getCommentableDoc()

getCommentableDoc

protected CommentableDocument getCommentableDoc(DocumentModel doc)

initComments

public void initComments()

Initializes uiComments with Comments of current document.

Specified by:

initComments in interface CommentManagerActions

initComments

public void initComments(DocumentModel commentedDoc)

Initializes uiComments with Comments of current document.

Specified by:

initComments in interface CommentManagerActions

getComments

public List<UIComment> getComments(DocumentModel doc)

getCommentsAsThreadOnDoc

public List<ThreadEntry> getCommentsAsThreadOnDoc(DocumentModel doc)

Recursively retrieves all comments of a doc.

Specified by:

getCommentsAsThreadOnDoc in interface CommentManagerActions

Returns:

list of ThreadEntry for given Document.

getCommentsAsThread

public List<ThreadEntry> getCommentsAsThread(DocumentModel commentedDoc)

Description copied from interface: CommentManagerActions

Initialize uiComments with given Document if uiComments is null.

Specified by:

getCommentsAsThread in interface CommentManagerActions

Returns:

list of ThreadEntry for given Document.

flattenTree

public void flattenTree(List<ThreadEntry> commentThread,
                        UIComment uiComment,
                        int depth)

Visits a list of comment trees and puts them into a list of "ThreadEntry"s.

createUIComment

protected UIComment createUIComment(UIComment parent,
                                    DocumentModel comment)

Creates a UIComment wrapping "comment", having "parent" as parent.

deleteComment

public String deleteComment(String commentId)

Specified by:

deleteComment in interface CommentManagerActions

deleteComment

public String deleteComment()

Specified by:

deleteComment in interface CommentManagerActions

getNewContent

public String getNewContent()

Specified by:

getNewContent in interface CommentManagerActions

setNewContent

public void setNewContent(String newContent)

Specified by:

setNewContent in interface CommentManagerActions

beginComment

public String beginComment()

Specified by:

beginComment in interface CommentManagerActions

cancelComment

public String cancelComment()

Specified by:

cancelComment in interface CommentManagerActions

getCommentStarted

public boolean getCommentStarted()

Specified by:

getCommentStarted in interface CommentManagerActions

getChildren

public void getChildren(UIComment comment)

Retrieves children for a given comment.

getLastCommentsByDate

public List<UIComment> getLastCommentsByDate(String commentNumber,
                                             DocumentModel commentedDoc)

Description copied from interface: CommentManagerActions

Retrieves a given number of comments from the given Document.

Specified by:

getLastCommentsByDate in interface CommentManagerActions

Parameters:

commentNumber - the number of comment to fetch

getLastCommentsByDate

public List<UIComment> getLastCommentsByDate(String commentNumber)

Description copied from interface: CommentManagerActions

Retrieves a given number of comments from currentDocument.

Specified by:

getLastCommentsByDate in interface CommentManagerActions

Parameters:

commentNumber - the number of comment to fetch

getSavedReplyCommentId

public String getSavedReplyCommentId()

Specified by:

getSavedReplyCommentId in interface CommentManagerActions

setSavedReplyCommentId

public void setSavedReplyCommentId(String savedReplyCommentId)

Specified by:

setSavedReplyCommentId in interface CommentManagerActions

getActionsForComment

public List<Action> getActionsForComment()

Specified by:

getActionsForComment in interface CommentManagerActions

Returns:

available action for COMMENTS_ACTIONS

getActionsForComment

public List<Action> getActionsForComment(String category)

Specified by:

getActionsForComment in interface CommentManagerActions

Returns:

available action for given category

getShowCreateForm

public boolean getShowCreateForm()

Specified by:

getShowCreateForm in interface CommentManagerActions

setShowCreateForm

public void setShowCreateForm(boolean flag)

Specified by:

setShowCreateForm in interface CommentManagerActions

toggleCreateForm

public void toggleCreateForm(javax.faces.event.ActionEvent event)

Specified by:

toggleCreateForm in interface CommentManagerActions

cleanContextVariable

public void cleanContextVariable()