com.hybris.backoffice.widgets.itemcomments

Class ItemCommentsController

java.lang.Object

DefaultWidgetController

com.hybris.backoffice.widgets.itemcomments.ItemCommentsController

public class ItemCommentsController
extends DefaultWidgetController

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	COMPONENT_ADD_COMMENT_BUTTON
protected static java.lang.String	COMPONENT_COMMENTS_COUNT_LABEL Deprecated. since 1811, the field is unused
protected static java.lang.String	COMPONENT_SHOW_POPUP_BUTTON Deprecated. since 1811, the field is unused
protected static java.lang.String	LABEL_NO_COMMENTS
protected static java.lang.String	MODEL_COMMENTS
protected static java.lang.String	MODEL_DATA_TYPE
static java.lang.String	MODEL_DATE_FORMATTER
protected static java.lang.String	SCLASS_ADD_COMMENT_SECTION
protected static java.lang.String	SCLASS_ADD_COMMENT_SECTION_BUTTON_CANCEL
protected static java.lang.String	SCLASS_ADD_COMMENT_SECTION_BUTTON_OK
protected static java.lang.String	SCLASS_ADD_COMMENT_SECTION_TEXTBOX
protected static java.lang.String	SCLASS_COMMENTS_LIST_EMPTY
protected static java.lang.String	SETTING_COMMENTS_LIST_RENDERER
protected static java.lang.String	SETTING_DATE_FORMAT
protected static java.lang.String	SETTING_DEFAULT_COMMENTS_COMMENT_TYPE
protected static java.lang.String	SETTING_DEFAULT_COMMENTS_COMPONENT
protected static java.lang.String	SETTING_DEFAULT_COMMENTS_DOMAIN
protected static java.lang.String	SETTING_DEFAULT_COMMENTS_LIST_RENDERER
protected static java.lang.String	SETTING_POPUP_POSITION
protected static java.lang.String	SOCKET_IN_INPUT_ITEM

Constructor Summary

Constructors

Constructor and Description
ItemCommentsController()

Method Summary

Modifier and Type	Method and Description
protected void	addCommentToItem(CommentModel newComment)
protected boolean	canCreateComment()
protected boolean	canReadThisComment(CommentModel comment)
protected void	closePopup()
protected Div	createAddCommentContainer(Textbox textbox, Button okButton, Button cancelButton)
protected <any>	createCancelButtonListener()
protected java.util.Optional<CommentModel>	createNewComment(java.lang.String text, ComponentModel component, CommentTypeModel commentType)
protected java.util.Optional<CommentModel>	createNewComment(Textbox textbox)
protected <any>	createOkButtonEventListener(Textbox textbox)
protected java.util.List<CommentModel>	filterNotPermitted(java.util.List<CommentModel> comments)
Button	getAddCommentButton()
Div	getAddCommentContainer()
<any>	getCommentRenderer()
Label	getCommentsCountLabel()
CommentService	getCommentService()
java.util.List<CommentModel>	getCommentsFromModel()
Div	getCommentsListContainer()
Popup	getCommentsPopup()
protected java.lang.String	getDefaultDateFormat()
ItemModel	getInputItemModel()
protected NotificationService	getNotificationService()
ObjectFacade	getObjectFacade()
protected java.util.Collection<Component>	getOpenPopupAwareComponents()
PermissionFacade	getPermissionFacade()
PopupPosition	getPopupPosition()
Button	getShowCommentsButton()
TypeFacade	getTypeFacade()
UserService	getUserService()
protected void	handleCommentSavingException(ObjectSavingException exception)
protected void	initDataType(ItemModel inputItem)
protected void	initDateFormatter()
void	initialize(Component component)
protected void	initPopupPosition()
protected void	initRenderer()
protected boolean	isCommentsChanged(ItemModel freshInputItemModel)
protected void	loadNewCommentsIfPossible()
protected void	notifyUserOfWrongSettings(java.lang.String wrongSettingsMessage)
void	onHeartbeat(CockpitEvent cockpitEvent)
void	onInputItemReceive(ItemModel inputItem)
void	openPopup()
protected void	render()
protected void	renderComments()
protected void	renderCommentsList()
protected void	renderContent()
protected void	renderEmptyMessage()
protected void	runWithReopeningPopup(Executable executable) Performs passed operation and closes and reopens comments popup so any modified elements in it will be recalculated correctly.
protected void	scrollToLastComment()
void	setAddCommentButton(Button addCommentButton)
void	setAddCommentContainer(Div addCommentContainer)
void	setCommentRenderer(<any> commentRenderer)
void	setCommentsCountLabel(Label commentsCountLabel)
void	setCommentService(CommentService commentService)
void	setCommentsListContainer(Div commentsListContainer)
void	setCommentsPopup(Popup commentsPopup)
void	setNotificationService(NotificationService notificationService)
void	setObjectFacade(ObjectFacade objectFacade)
protected void	setOnClickEventListenersForOpenPopupAwareComponent(Component component, boolean clickable)
protected void	setOpenPopupAwareComponentsClickability()
void	setPermissionFacade(PermissionFacade permissionFacade)
void	setPopupPosition(PopupPosition popupPosition)
void	setShowCommentsButton(Button showCommentsButton)
void	setTypeFacade(TypeFacade typeFacade)
protected void	setUIStateForOpenPopupAwareComponent(Component component, boolean clickable)
void	setUserService(UserService userService)
void	showNewCommentSection()
protected void	sortAndSetComments(java.util.List<CommentModel> comments)
protected void	tryToSaveItemComment(CommentModel comment)

Methods inherited from class java.lang.Object

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

Field Detail

MODEL_DATE_FORMATTER

public static final java.lang.String MODEL_DATE_FORMATTER

See Also:

Constant Field Values

SOCKET_IN_INPUT_ITEM

protected static final java.lang.String SOCKET_IN_INPUT_ITEM

See Also:

Constant Field Values

SETTING_COMMENTS_LIST_RENDERER

protected static final java.lang.String SETTING_COMMENTS_LIST_RENDERER

See Also:

Constant Field Values

SETTING_POPUP_POSITION

protected static final java.lang.String SETTING_POPUP_POSITION

See Also:

Constant Field Values

SETTING_DATE_FORMAT

protected static final java.lang.String SETTING_DATE_FORMAT

See Also:

Constant Field Values

SETTING_DEFAULT_COMMENTS_LIST_RENDERER

protected static final java.lang.String SETTING_DEFAULT_COMMENTS_LIST_RENDERER

See Also:

Constant Field Values

SETTING_DEFAULT_COMMENTS_DOMAIN

protected static final java.lang.String SETTING_DEFAULT_COMMENTS_DOMAIN

See Also:

Constant Field Values

SETTING_DEFAULT_COMMENTS_COMPONENT

protected static final java.lang.String SETTING_DEFAULT_COMMENTS_COMPONENT

See Also:

Constant Field Values

SETTING_DEFAULT_COMMENTS_COMMENT_TYPE

protected static final java.lang.String SETTING_DEFAULT_COMMENTS_COMMENT_TYPE

See Also:

Constant Field Values

COMPONENT_SHOW_POPUP_BUTTON

@Deprecated
protected static final java.lang.String COMPONENT_SHOW_POPUP_BUTTON

Deprecated. since 1811, the field is unused

See Also:

Constant Field Values

COMPONENT_COMMENTS_COUNT_LABEL

@Deprecated
protected static final java.lang.String COMPONENT_COMMENTS_COUNT_LABEL

Deprecated. since 1811, the field is unused

See Also:

Constant Field Values

COMPONENT_ADD_COMMENT_BUTTON

protected static final java.lang.String COMPONENT_ADD_COMMENT_BUTTON

See Also:

Constant Field Values

SCLASS_ADD_COMMENT_SECTION

protected static final java.lang.String SCLASS_ADD_COMMENT_SECTION

See Also:

Constant Field Values

SCLASS_ADD_COMMENT_SECTION_TEXTBOX

protected static final java.lang.String SCLASS_ADD_COMMENT_SECTION_TEXTBOX

See Also:

Constant Field Values

SCLASS_ADD_COMMENT_SECTION_BUTTON_OK

protected static final java.lang.String SCLASS_ADD_COMMENT_SECTION_BUTTON_OK

See Also:

Constant Field Values

SCLASS_ADD_COMMENT_SECTION_BUTTON_CANCEL

protected static final java.lang.String SCLASS_ADD_COMMENT_SECTION_BUTTON_CANCEL

See Also:

Constant Field Values

SCLASS_COMMENTS_LIST_EMPTY

protected static final java.lang.String SCLASS_COMMENTS_LIST_EMPTY

See Also:

Constant Field Values

LABEL_NO_COMMENTS

protected static final java.lang.String LABEL_NO_COMMENTS

See Also:

Constant Field Values

MODEL_DATA_TYPE

protected static final java.lang.String MODEL_DATA_TYPE

See Also:

Constant Field Values

MODEL_COMMENTS

protected static final java.lang.String MODEL_COMMENTS

See Also:

Constant Field Values

Constructor Detail

ItemCommentsController

public ItemCommentsController()

Method Detail

initialize

public void initialize(Component component)

onInputItemReceive

public void onInputItemReceive(ItemModel inputItem)

scrollToLastComment

protected void scrollToLastComment()

showNewCommentSection

public void showNewCommentSection()

onHeartbeat

public void onHeartbeat(CockpitEvent cockpitEvent)

openPopup

public void openPopup()

loadNewCommentsIfPossible

protected void loadNewCommentsIfPossible()
                                  throws ObjectNotFoundException

Throws:

ObjectNotFoundException

setOpenPopupAwareComponentsClickability

protected void setOpenPopupAwareComponentsClickability()

getOpenPopupAwareComponents

protected java.util.Collection<Component> getOpenPopupAwareComponents()

setUIStateForOpenPopupAwareComponent

protected void setUIStateForOpenPopupAwareComponent(Component component,
                                                    boolean clickable)

setOnClickEventListenersForOpenPopupAwareComponent

protected void setOnClickEventListenersForOpenPopupAwareComponent(Component component,
                                                                  boolean clickable)

isCommentsChanged

protected boolean isCommentsChanged(ItemModel freshInputItemModel)

runWithReopeningPopup

protected void runWithReopeningPopup(Executable executable)

Performs passed operation and closes and reopens comments popup so any modified elements in it will be recalculated correctly. If popup was closed is not opened again (in case to call this method from onHeartbeat(CockpitEvent) )

Parameters:

executable - passed operation which will be executed before popup will be reopened.

closePopup

protected void closePopup()

createAddCommentContainer

protected Div createAddCommentContainer(Textbox textbox,
                                        Button okButton,
                                        Button cancelButton)

createOkButtonEventListener

protected <any> createOkButtonEventListener(Textbox textbox)

createCancelButtonListener

protected <any> createCancelButtonListener()

tryToSaveItemComment

protected void tryToSaveItemComment(CommentModel comment)

handleCommentSavingException

protected void handleCommentSavingException(ObjectSavingException exception)

addCommentToItem

protected void addCommentToItem(CommentModel newComment)
                         throws ObjectSavingException

Throws:

ObjectSavingException

createNewComment

protected java.util.Optional<CommentModel> createNewComment(Textbox textbox)
                                                     throws ObjectCreationException

Throws:

ObjectCreationException

notifyUserOfWrongSettings

protected void notifyUserOfWrongSettings(java.lang.String wrongSettingsMessage)

createNewComment

protected java.util.Optional<CommentModel> createNewComment(java.lang.String text,
                                                            ComponentModel component,
                                                            CommentTypeModel commentType)
                                                     throws ObjectCreationException

Throws:

ObjectCreationException

getInputItemModel

public ItemModel getInputItemModel()

getCommentsFromModel

public java.util.List<CommentModel> getCommentsFromModel()

render

protected void render()

renderCommentsList

protected void renderCommentsList()

renderContent

protected void renderContent()

renderEmptyMessage

protected void renderEmptyMessage()

renderComments

protected void renderComments()

getDefaultDateFormat

protected java.lang.String getDefaultDateFormat()

initDataType

protected void initDataType(ItemModel inputItem)

initDateFormatter

protected void initDateFormatter()

initRenderer

protected void initRenderer()

initPopupPosition

protected void initPopupPosition()

sortAndSetComments

protected void sortAndSetComments(java.util.List<CommentModel> comments)

filterNotPermitted

protected java.util.List<CommentModel> filterNotPermitted(java.util.List<CommentModel> comments)

canReadThisComment

protected boolean canReadThisComment(CommentModel comment)

canCreateComment

protected boolean canCreateComment()

getCommentsListContainer

public Div getCommentsListContainer()

setCommentsListContainer

public void setCommentsListContainer(Div commentsListContainer)

getShowCommentsButton

public Button getShowCommentsButton()

setShowCommentsButton

public void setShowCommentsButton(Button showCommentsButton)

getCommentsCountLabel

public Label getCommentsCountLabel()

setCommentsCountLabel

public void setCommentsCountLabel(Label commentsCountLabel)

getPopupPosition

public PopupPosition getPopupPosition()

setPopupPosition

public void setPopupPosition(PopupPosition popupPosition)

getCommentsPopup

public Popup getCommentsPopup()

setCommentsPopup

public void setCommentsPopup(Popup commentsPopup)

getAddCommentButton

public Button getAddCommentButton()

setAddCommentButton

public void setAddCommentButton(Button addCommentButton)

getAddCommentContainer

public Div getAddCommentContainer()

setAddCommentContainer

public void setAddCommentContainer(Div addCommentContainer)

getObjectFacade

public ObjectFacade getObjectFacade()

setObjectFacade

public void setObjectFacade(ObjectFacade objectFacade)

getTypeFacade

public TypeFacade getTypeFacade()

setTypeFacade

public void setTypeFacade(TypeFacade typeFacade)

getUserService

public UserService getUserService()

setUserService

public void setUserService(UserService userService)

getCommentService

public CommentService getCommentService()

setCommentService

public void setCommentService(CommentService commentService)

getCommentRenderer

public <any> getCommentRenderer()

setCommentRenderer

public void setCommentRenderer(<any> commentRenderer)

getPermissionFacade

public PermissionFacade getPermissionFacade()

setPermissionFacade

public void setPermissionFacade(PermissionFacade permissionFacade)

getNotificationService

protected NotificationService getNotificationService()

setNotificationService

public void setNotificationService(NotificationService notificationService)