de.hybris.platform.hmc

Interface IconViewModel

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AbstractIconViewModel

public interface IconViewModel
extends java.io.Serializable

Data model for a IconViewChip.

Method Summary

Modifier and Type	Method and Description
void	copy(java.lang.Object element)
void	edit(java.lang.Object element) Notifies the model about an element being edited.
int[]	getBoxSize() May provide a custom box size if needed.
java.lang.String	getDescription(java.lang.Object element) May provide a description text for a given element which is currently displayed.
java.util.List	getElements(java.lang.Object parent) Returns subelements of a given parent element within the view.
java.util.List	getElements(java.lang.Object parent, java.lang.String searchPattern) Returns subelements of a given parent element within the view which match the given search pattern.
IconChip	getIconChip(IconViewChip parent, java.lang.Object element) Optionally the model may provide custom icon chips to render elements.
java.lang.String	getIconPathLabel(java.lang.Object element) May provide an additional titel for showing the element within the currently selected path.
java.lang.String	getIconTitle(java.lang.Object element) Must provide the icon subtitle for a given element which is currently displayed.
java.lang.String	getIconTooltip(java.lang.Object element) May provide a tooltip text for a given element which is currently displayed.
java.lang.String	getIconURI(java.lang.Object element) Must provide the icon URI for a given element which is currently displayed.
java.lang.String	getJSPURI() Deprecated. since ages - please usegetIconChip(IconViewChip, Object) to control icon rendering
java.util.List	getMenuEntries(java.lang.Object element)
java.lang.String	getNonExplorableIconURI(java.lang.Object element) May provide an additional icon for elements which are not explorable.
int	getNumberOfColumns() Returns the number of icon columns which should be shown.
java.util.List	getRootElements() Returns all root elements of the view.
boolean	isCopyable(java.lang.Object element)
boolean	isEditable(java.lang.Object element) Tells whether a element should be displayed as editable.
boolean	isExplorable(java.lang.Object element) Tells whether a element should be displayed as explorable which means it can be opened and provides subelements.
boolean	isRemovable(java.lang.Object element)
boolean	open(java.lang.Object element) Notifies the model about an element being opened.
boolean	processMenuEvent(java.lang.Object element, java.lang.String event, java.lang.String value)
void	remove(java.lang.Object element)

Method Detail

getBoxSize

int[] getBoxSize()

May provide a custom box size if needed. Otherwise each icon is show at its exact size which may result in bad flow behaviour if there are differently sized icons.

Returns:

[width,height] or null if the size shouldnt be limited

getNumberOfColumns

int getNumberOfColumns()

Returns the number of icon columns which should be shown. Return -1 to indicate that the number of columns is only restricted by the available space.

Returns:

the number of icons which should be rendered in one row

Since:

2.10

getJSPURI

@Deprecated
java.lang.String getJSPURI()

Deprecated. since ages - please usegetIconChip(IconViewChip, Object) to control icon rendering

Returns the uri of the jsp which should render this icon view model.

Returns:

the uri of the jsp which should render this icon view model.

Since:

2.10

getIconChip

IconChip getIconChip(IconViewChip parent,
                     java.lang.Object element)

Optionally the model may provide custom icon chips to render elements. If no chip is provided the default class IconChip is used.

Parameters:

parent - the containing chip

element - the element to render

getRootElements

java.util.List getRootElements()

Returns all root elements of the view. This is called once per page rendering.

getElements

java.util.List getElements(java.lang.Object parent)

Returns subelements of a given parent element within the view. This is called once per page rendering.

Parameters:

parent - the parent element; never null

getElements

java.util.List getElements(java.lang.Object parent,
                           java.lang.String searchPattern)

Returns subelements of a given parent element within the view which match the given search pattern.

The pattern will contain parts of the icon path label including the following special characters:

• : variable wildcard at any position
• ? : single character wildcard at any position

Parameters:

parent - the parent element; never null

searchPattern - the search pattern

getIconURI

java.lang.String getIconURI(java.lang.Object element)

Must provide the icon URI for a given element which is currently displayed.

Parameters:

element - the displayed element

getNonExplorableIconURI

java.lang.String getNonExplorableIconURI(java.lang.Object element)

May provide an additional icon for elements which are not explorable.

Parameters:

element - the displayed element

getIconTitle

java.lang.String getIconTitle(java.lang.Object element)

Must provide the icon subtitle for a given element which is currently displayed.

Parameters:

element - the displayed element

getIconPathLabel

java.lang.String getIconPathLabel(java.lang.Object element)

May provide an additional titel for showing the element within the currently selected path. If nothing is provided getIconTitle(Object) is used.

Parameters:

element -

getIconTooltip

java.lang.String getIconTooltip(java.lang.Object element)

May provide a tooltip text for a given element which is currently displayed.

Parameters:

element - the displayed element

getDescription

java.lang.String getDescription(java.lang.Object element)

May provide a description text for a given element which is currently displayed.

Parameters:

element - the displayed element

Since:

2.10

isExplorable

boolean isExplorable(java.lang.Object element)

Tells whether a element should be displayed as explorable which means it can be opened and provides subelements. If the element is actually going to be opened, open(Object) is called upon the model.

Parameters:

element - which is currently displayed

isEditable

boolean isEditable(java.lang.Object element)

Tells whether a element should be displayed as editable. This causes an [edit]-link to be displayed and edit(Object) is called upon the model in case is was triggered.

Parameters:

element - which is currently displayed

isRemovable

boolean isRemovable(java.lang.Object element)

Since:

2.3beta

isCopyable

boolean isCopyable(java.lang.Object element)

Since:

2.3beta

open

boolean open(java.lang.Object element)

Notifies the model about an element being opened. Please note that the IconViewChip automatically displays its subelements so no view logic needs to be done here.

Parameters:

element - the element which is opened

Returns:

true if the view should display the element as new root element - if false the path remains unchanged

edit

void edit(java.lang.Object element)

Notifies the model about an element being edited. Since the ViewIconChip does not know how to edit an element the chip does nothing besides calling this method so the model has to trigger view logic itself.

Parameters:

element - the element which should be edited

remove

void remove(java.lang.Object element)

Since:

2.3beta

copy

void copy(java.lang.Object element)

Since:

2.3beta

getMenuEntries

java.util.List getMenuEntries(java.lang.Object element)

Since:

2.3beta

processMenuEvent

boolean processMenuEvent(java.lang.Object element,
                         java.lang.String event,
                         java.lang.String value)

Returns:

true if the event was effective - menu event dispatching will stop in this case

Since:

2.3beta