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

Class CommentLayerComponent

java.lang.Object

Div

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

public class CommentLayerComponent
extends Div

Use this component as comment - layer over other, parent HTML component. Its purpose is allow placing positioned comments over images (i.e. in printcockpit - over page previews), but it is possible to use a custom div component with any content as parent of such component. This component is design in the MVC pattern. It must be constructed with an instance of CommentLayerComponentController and CommentLayerComponentModel. The former triggers any comment-layer actions, like placing new comment, reading comment for the comment layer, while the later holds the current state of the component. Besides controller and model, the constructor requires the HTML component that is the parent of the comment layer component (or in other words, lays below the comment layer)

Constructor Summary

Constructors

Constructor and Description
CommentLayerComponent(CommentLayerComponentController controller, CommentLayerComponentModel model, HtmlBasedComponent parent)

Method Summary

Modifier and Type	Method and Description
boolean	addIconComponent(CommentIcon icon) Adds new comment icon component to the comment layer.
void	appendCanvas(Canvas canvas) Appends canvas element to this comment layer component.
boolean	containsComment(CommentModel commentModel) Returns true if this component contains given comment or false otherwise.
Canvas	getCanvas()
CommentIcon	getCommentIcon(CommentModel commentModel) Returns CommentIcon corresponding to the target CommentModel instance
CommentIcon	getCommentIcon(java.lang.String id) Returns CommentIcon contained in this component and having target component id.
protected Menupopup	getContextMenu() Creates the context menu for the right-click listener.
CommentLayerComponentController	getController() Returns the comment layer's controller.
java.util.List<CommentIcon>	getIconComponents() Returns all comment icons components that are currently contained by this comment layer.
protected Menupopup	getIconContextMenu(CommentIcon icon)
CommentLayerComponentModel	getModel() Returns current state of the comment layer component - CommentLayerComponentModel.
HtmlBasedComponent	getParent()
void	refresh() Refreshes the component according to the current state in the model.
void	refresh(CommentLayerComponentModel model) Refreshes the component according to the current state in the model.
protected void	refreshCanvas() Refreshes (if the comment layer component is in edit mode) or clears the canvas component.
boolean	removeIcon(CommentIcon icon) Removes icon comment component from the comment layer.
void	resize(double scaleFactor) Resizes the component according to the given scale factor.
protected void	setListeners()
void	setModel(CommentLayerComponentModel model) Sets model to the component.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentLayerComponent

public CommentLayerComponent(CommentLayerComponentController controller,
                             CommentLayerComponentModel model,
                             HtmlBasedComponent parent)

Method Detail

setModel

public void setModel(CommentLayerComponentModel model)

Sets model to the component.

Parameters:

model - - CommentLayerComponentModel

getModel

public CommentLayerComponentModel getModel()

Returns current state of the comment layer component - CommentLayerComponentModel.

getController

public CommentLayerComponentController getController()

Returns the comment layer's controller.

refresh

public void refresh(CommentLayerComponentModel model)

Refreshes the component according to the current state in the model. Besides the width and height, it also sets the listeners according to the given state in the model. Refresh is propagated further to the contained components:

• comment icons
• canvas

Parameters:

model - - the state representation

refreshCanvas

protected void refreshCanvas()

Refreshes (if the comment layer component is in edit mode) or clears the canvas component.

refresh

public void refresh()

Refreshes the component according to the current state in the model. Besides the width and height, it also sets the listeners according to the current state in the model. Refresh is propagated further to the contained components:

• comment icons
• canvas

resize

public void resize(double scaleFactor)

Resizes the component according to the given scale factor. the dimensions are changed in the model, so the actual view will nor be changed until refresh() is called.

getIconComponents

public java.util.List<CommentIcon> getIconComponents()

Returns all comment icons components that are currently contained by this comment layer.

Returns:

List of CommentIcons

addIconComponent

public boolean addIconComponent(CommentIcon icon)

Adds new comment icon component to the comment layer.

Parameters:

icon - CommentIcon

removeIcon

public boolean removeIcon(CommentIcon icon)

Removes icon comment component from the comment layer.

Parameters:

icon - - icon to remove

containsComment

public boolean containsComment(CommentModel commentModel)

Returns true if this component contains given comment or false otherwise.

Parameters:

commentModel - comment to search for

getCommentIcon

public CommentIcon getCommentIcon(CommentModel commentModel)

Returns CommentIcon corresponding to the target CommentModel instance

Parameters:

commentModel -

Returns:

CommentIcon or null.

getCommentIcon

public CommentIcon getCommentIcon(java.lang.String id)

Returns CommentIcon contained in this component and having target component id.

Parameters:

id - - commentIcon Id

getCanvas

public Canvas getCanvas()

Returns:

the canvas element

appendCanvas

public void appendCanvas(Canvas canvas)

Appends canvas element to this comment layer component. It should be drawn over the component.

Parameters:

canvas - Canvas

getParent

public HtmlBasedComponent getParent()

Returns:

the parent

getContextMenu

protected Menupopup getContextMenu()

Creates the context menu for the right-click listener. The method delegates to the controller - CommentLayerComponentController.createContextMenu(CommentLayerComponent);

Returns:

Menupopup

getIconContextMenu

protected Menupopup getIconContextMenu(CommentIcon icon)

setListeners

protected void setListeners()