de.hybris.platform.cockpit.components.mvc.commentlayer.controller

Interface ContextAreaCommentTreeController

All Known Implementing Classes:

DefaultContextAreaCommentTreeController

public interface ContextAreaCommentTreeController

Contract definition of controller for ContextAreaCommentTreeComponent

Method Summary

Modifier and Type	Method and Description
void	deleteComment(ContextAreaCommentTreeModel model, CommentModel commentItemModel) Performs delete routine for the given comment instance.
CommentIcon	getCommentIcon(ContextAreaCommentTreeModel model, CommentModel comment) Returns a corresponding CommentIcon component for the target comment instance.
CommentLayerComponent	getOwningCommentLayer(ContextAreaCommentTreeModel model, CommentModel commentItemModel) Returns CommentLayerComponent that owns icon representing the target comment instance.
boolean	getUserWorkingStatus(AbstractCommentModel comment) Returns working status of the target AbstractCommentModel instance for the current user.
boolean	isCommentCurrentlySelected(ContextAreaCommentTreeModel model, AbstractCommentModel commentItemModel) Evaluates if the target comment instance is currently selected in the comment layer.
boolean	isCommentRecordCollapsable(AbstractCommentModel abstractComment) Evaluates if the record of the context area comment tree for the given AbstractCommentModel should render the collapse/expand control.
boolean	isCommentVisible(ContextAreaCommentTreeModel model, CommentModel comment) Evaluates if the target comment is currently visible on the comment layer.
void	selectComment(ContextAreaCommentTreeModel model, CommentModel commentItemModel) Performs select routine for the given comment instance.
void	setUserWorkingStatus(AbstractCommentModel comment, boolean workingStatus) Sets working status of the target AbstractCommentModel instance for the current user.
void	toggleCommentVisible(ContextAreaCommentTreeModel model, CommentModel comment) Toggles visibility of the target comment instance on the comment layer component.

Method Detail

isCommentCurrentlySelected

boolean isCommentCurrentlySelected(ContextAreaCommentTreeModel model,
                                   AbstractCommentModel commentItemModel)

Evaluates if the target comment instance is currently selected in the comment layer.

Parameters:

model - ContextAreaCommentTreeModel

commentItemModel - - instance to check

isCommentVisible

boolean isCommentVisible(ContextAreaCommentTreeModel model,
                         CommentModel comment)

Evaluates if the target comment is currently visible on the comment layer.

Parameters:

model - - ContextAreaCommentTreeModel

comment - - comment instance to check

selectComment

void selectComment(ContextAreaCommentTreeModel model,
                   CommentModel commentItemModel)

Performs select routine for the given comment instance.

Parameters:

model - - ContextAreaCommentTreeModel

commentItemModel - - comment instance to select

deleteComment

void deleteComment(ContextAreaCommentTreeModel model,
                   CommentModel commentItemModel)

Performs delete routine for the given comment instance.

Parameters:

model - - ContextAreaCommentTreeModel

commentItemModel - - comment instance to select

toggleCommentVisible

void toggleCommentVisible(ContextAreaCommentTreeModel model,
                          CommentModel comment)

Toggles visibility of the target comment instance on the comment layer component.

Parameters:

model - - ContextAreaCommentTreeModel

comment - - target comment instance.

getOwningCommentLayer

CommentLayerComponent getOwningCommentLayer(ContextAreaCommentTreeModel model,
                                            CommentModel commentItemModel)

Returns CommentLayerComponent that owns icon representing the target comment instance.

Parameters:

model - - ContextAreaCommentTreeModel

commentItemModel - - target comment instance

getUserWorkingStatus

boolean getUserWorkingStatus(AbstractCommentModel comment)

Returns working status of the target AbstractCommentModel instance for the current user.

Parameters:

comment - - target AbstractCommentModel instance.

Returns:

true or false

setUserWorkingStatus

void setUserWorkingStatus(AbstractCommentModel comment,
                          boolean workingStatus)

Sets working status of the target AbstractCommentModel instance for the current user.

Parameters:

comment - - target AbstractCommentModel instance.

workingStatus - - new working status value.

isCommentRecordCollapsable

boolean isCommentRecordCollapsable(AbstractCommentModel abstractComment)

Evaluates if the record of the context area comment tree for the given AbstractCommentModel should render the collapse/expand control.

getCommentIcon

CommentIcon getCommentIcon(ContextAreaCommentTreeModel model,
                           CommentModel comment)

Returns a corresponding CommentIcon component for the target comment instance.

Parameters:

model - - ContextAreaCommentTreeModel

comment - - target CommentModel

Returns:

CommentIcon or null