IconViewModel (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractIconViewModel
```
public interface IconViewModel
extends Serializable
```
Data model for a IconViewChip.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`copy(Object element)`
`void`	`edit(Object element)` Notifies the model about an element being edited.
`int[]`	`getBoxSize()` May provide a custom box size if needed.
`String`	`getDescription(Object element)` May provide a description text for a given element which is currently displayed.
`List`	`getElements(Object parent)` Returns subelements of a given parent element within the view.
`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`	`getIconTitle(Object element)` Must provide the icon subtitle for a given element which is currently displayed.
`String`	`getIconTooltip(Object element)` May provide a tooltip text for a given element which is currently displayed.
`String`	`getIconURI(Object element)` Must provide the icon URI for a given element which is currently displayed.
`String`	`getJSPURI()` Deprecated. please use `getIconChip(IconViewChip, Object)` to control icon rendering
`List`	`getMenuEntries(Object element)`
`String`	`getNonExplorableIconURI(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.
`List`	`getRootElements()` Returns all root elements of the view.
`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)` Notifies the model about an element being opened.
`boolean`	`processMenuEvent(Object element, String event, String value)`
`void`	`remove(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
String getJSPURI()
```
    Deprecated. please use getIconChip(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,
                     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
```
List getRootElements()
```
    Returns all root elements of the view. This is called once per page rendering.
  - getElements
```
List getElements(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
```
List getElements(Object parent,
                 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
```
String getIconURI(Object element)
```
    Must provide the icon URI for a given element which is currently displayed.
    
    Parameters:
    
    element - the displayed element
  - getNonExplorableIconURI
```
String getNonExplorableIconURI(Object element)
```
    May provide an additional icon for elements which are not explorable.
    
    Parameters:
    
    element - the displayed element
  - getIconTitle
```
String getIconTitle(Object element)
```
    Must provide the icon subtitle for a given element which is currently displayed.
    
    Parameters:
    
    element - the displayed element
  - getIconPathLabel
```
String getIconPathLabel(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
```
String getIconTooltip(Object element)
```
    May provide a tooltip text for a given element which is currently displayed.
    
    Parameters:
    
    element - the displayed element
  - getDescription
```
String getDescription(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(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(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(Object element)
```
    Since:
    
    2.3beta
  - isCopyable
```
boolean isCopyable(Object element)
```
    Since:
    
    2.3beta
  - open
```
boolean open(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(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(Object element)
```
    Since:
    
    2.3beta
  - copy
```
void copy(Object element)
```
    Since:
    
    2.3beta
  - getMenuEntries
```
List getMenuEntries(Object element)
```
    Since:
    
    2.3beta
  - processMenuEvent
```
boolean processMenuEvent(Object element,
                         String event,
                         String value)
```
    Returns:
    
    true if the event was effective - menu event dispatching will stop in this case
    
    Since:
    
    2.3beta

Interface IconViewModel

Method Summary

Method Detail

getBoxSize

getNumberOfColumns

getJSPURI

getIconChip

getRootElements

getElements

getElements

getIconURI

getNonExplorableIconURI

getIconTitle

getIconPathLabel

getIconTooltip

getDescription

isExplorable

isEditable

isRemovable

isCopyable

open

edit

remove

copy

getMenuEntries

processMenuEvent