de.hybris.platform.hmc

Class AbstractIconViewModel

java.lang.Object

de.hybris.platform.hmc.AbstractIconViewModel

All Implemented Interfaces:

IconViewModel, Serializable

public abstract class AbstractIconViewModel
extends Object
implements IconViewModel

Base class for icon view models which provides some basic layout functionality.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int[]	DEFAULT_BOX_SIZE

Constructor Summary

Constructors

Constructor and Description
AbstractIconViewModel()

Method Summary

Modifier and Type	Method and Description
void	copy(Object element)
void	edit(Object element) Does nothing as default.
int[]	getBoxSize() Defines a default box size of [ 150, 100 ].
String	getDescription(Object element) Returns the icon tooltip as a fallback.
List	getElements(Object parent, String searchPattern) Returns subelements of a given parent element within the view which match the given search pattern.
IconChip	getIconChip(IconViewChip parent, Object element) Optionally the model may provide custom icon chips to render elements.
String	getIconPathLabel(Object element) May provide an additional titel for showing the element within the currently selected path.
String	getIconTooltip(Object element) Returns the icon title as a fallback.
String	getIconURI(Object element) Must provide the icon URI for a given element which is currently displayed.
String	getJSPURI() Default implementation of IconViewModel.getJSPURI().
List	getMenuEntries(Object element) Returns empty list as default.
String	getNonExplorableIconURI(Object element) May provide an additional icon for elements which are not explorable.
int	getNumberOfColumns() Returns -1 to indicate that the number of icons in a row is not restricted.
boolean	isCopyable(Object element)
boolean	isEditable(Object element) Tells whether a element should be displayed as editable.
boolean	isExplorable(Object element) Tells whether a element should be displayed as explorable which means it can be opened and provides subelements.
boolean	isRemovable(Object element)
boolean	open(Object element) Does nothing as default.
protected String	prepareRegExpPattern(String query)
boolean	processMenuEvent(Object element, String event, String value) Does npthing by default.
void	remove(Object element)

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.hmc.IconViewModel

getElements, getIconTitle, getRootElements

Field Detail

DEFAULT_BOX_SIZE

protected int[] DEFAULT_BOX_SIZE

Constructor Detail

AbstractIconViewModel

public AbstractIconViewModel()

Method Detail

getBoxSize

public int[] getBoxSize()

Defines a default box size of [ 150, 100 ]. Override this method to provide a different size or null if size should not be limited.

Specified by:

getBoxSize in interface IconViewModel

Returns:

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

See Also:

IconViewModel.getBoxSize()

getDescription

public String getDescription(Object element)

Returns the icon tooltip as a fallback. Implement this method to provide a proper description.

Specified by:

getDescription in interface IconViewModel

Parameters:

element - the displayed element

Returns:

The icon tooltip as a description.

Since:

2.10

See Also:

IconViewModel.getDescription(Object)

getNumberOfColumns

public int getNumberOfColumns()

Returns -1 to indicate that the number of icons in a row is not restricted. Implement this method if you want to display a fixed 2 column layout, for example.

Specified by:

getNumberOfColumns in interface IconViewModel

Returns:

the number of icons which should be rendered in one row

Since:

2.10

See Also:

IconViewModel.getNumberOfColumns()

getJSPURI

public String getJSPURI()

Default implementation of IconViewModel.getJSPURI(). Returns "iconViewChip.jsp".

Specified by:

getJSPURI in interface IconViewModel

Returns:

"iconViewChip.jsp".

Since:

2.10

See Also:

IconViewModel.getJSPURI()

getIconChip

public IconChip getIconChip(IconViewChip parent,
                            Object element)

Description copied from interface: IconViewModel

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

Specified by:

getIconChip in interface IconViewModel

Parameters:

parent - the containing chip

element - the element to render

getIconTooltip

public String getIconTooltip(Object element)

Returns the icon title as a fallback. Implement this method to provide a proper tooltip.

Specified by:

getIconTooltip in interface IconViewModel

Parameters:

element - the displayed element

Returns:

The icon title as tooltip.

See Also:

IconViewModel.getIconTooltip(java.lang.Object)

getIconPathLabel

public String getIconPathLabel(Object element)

Description copied from interface: IconViewModel

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

Specified by:

getIconPathLabel in interface IconViewModel

getIconURI

public String getIconURI(Object element)

Description copied from interface: IconViewModel

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

Specified by:

getIconURI in interface IconViewModel

Parameters:

element - the displayed element

getNonExplorableIconURI

public String getNonExplorableIconURI(Object element)

Description copied from interface: IconViewModel

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

Specified by:

getNonExplorableIconURI in interface IconViewModel

Parameters:

element - the displayed element

isExplorable

public boolean isExplorable(Object element)

Description copied from interface: IconViewModel

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, IconViewModel.open(Object) is called upon the model.

Specified by:

isExplorable in interface IconViewModel

Parameters:

element - which is currently displayed

Returns:

false as default so all icons cannot be explored.

See Also:

IconViewModel.isExplorable(java.lang.Object)

isEditable

public boolean isEditable(Object element)

Description copied from interface: IconViewModel

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

Specified by:

isEditable in interface IconViewModel

Parameters:

element - which is currently displayed

Returns:

false as default so all icon cannot be opened externally.

See Also:

IconViewModel.isEditable(java.lang.Object)

open

public boolean open(Object element)

Does nothing as default.

Specified by:

open in interface IconViewModel

Parameters:

element - the element which is opened

Returns:

the explorable status of the element via isExplorable(Object)

See Also:

IconViewModel.open(java.lang.Object)

edit

public void edit(Object element)

Does nothing as default.

Specified by:

edit in interface IconViewModel

Parameters:

element - the element which should be edited

See Also:

IconViewModel.edit(java.lang.Object)

getMenuEntries

public List getMenuEntries(Object element)

Returns empty list as default.

Specified by:

getMenuEntries in interface IconViewModel

processMenuEvent

public boolean processMenuEvent(Object element,
                                String event,
                                String value)

Does npthing by default.

Specified by:

processMenuEvent in interface IconViewModel

Returns:

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

isRemovable

public boolean isRemovable(Object element)

Specified by:

isRemovable in interface IconViewModel

remove

public void remove(Object element)

Specified by:

remove in interface IconViewModel

isCopyable

public boolean isCopyable(Object element)

Specified by:

isCopyable in interface IconViewModel

copy

public void copy(Object element)

Specified by:

copy in interface IconViewModel

prepareRegExpPattern

protected String prepareRegExpPattern(String query)

getElements

public List getElements(Object parent,
                        String searchPattern)

Description copied from interface: IconViewModel

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

Specified by:

getElements in interface IconViewModel

Parameters:

parent - the parent element; never null

searchPattern - the search pattern