IconViewChip (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- de.hybris.platform.hmc.webchips.AbstractChip
- - de.hybris.platform.hmc.IconViewChip

All Implemented Interfaces:

AjaxRequestHandler, Chip, Serializable, Cloneable
```
public class IconViewChip
extends AbstractChip
implements AjaxRequestHandler
```
Base chip for viewing elements as icons, opening and editing them. By providing a IconViewModel the actual data model can be defined freely. The chip keeps track of the selected elements, provides the hierarchy path and allows edit and open actions upon each element.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AJAX_COUNT`
`static String`	`AJAX_INPUT`
`static String`	`AJAX_QUERY`
`static String`	`AJAX_RESULT`
`static String`	`COPY`
`static String`	`EDIT`
`static String`	`FOLDER_ICON`
`static String`	`GOTO`
`static String`	`PATH`
`static String`	`REMOVE`
`static String`	`UNAVAILABLE_ICON`
`static String`	`UNKNOWN_ICON`
`static String`	`UP`

Fields inherited from class de.hybris.platform.hmc.webchips.AbstractChip
CHIP_KEY, FALSE, FRAME_KEY, SHOW_JSP_COMMENTS, TRUE, USE_SOCKET_NAMING

Fields inherited from interface de.hybris.platform.hmc.webchips.Chip
DISPLAY_EVENT, FILTERED_PREFIX

Constructor Summary

Constructors
Constructor and Description

IconViewChip(DisplayState displayState, Chip parent, IconViewModel model)
Creates a new IconViewChip.

Constructors
Constructor and Description
`IconViewChip(DisplayState displayState, Chip parent, IconViewModel model)` Creates a new IconViewChip.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addPathToHistory(List path)`
`protected void`	`addToPath(Object element)` Expands the path by the selected element.
`void`	`back()` Goes back one element of the current path.
`void`	`backTo(Object element)` Goes back to the specified element.
`boolean`	`canGoBack()`
`boolean`	`canGoForward()`
`protected void`	`cutPathTo(Object element)` Cuts the selection path down to the specified element.
`void`	`forward()`
`AutoCompleterComponent`	`getAutoCompleter()`
`Object`	`getCurrentElement()`
`List`	`getElementChips()`
`List`	`getElements()` Returns all curretly displayable elements. Please call this method instead of `IconViewModel.getElements(Object)` directly - otherwise actions will not work!
`String`	`getJSPURI()` Returns the URI of the JSP that this chip wants to use.
`List`	`getMenuEntries()` Here you can specify what Actions you are able to perform at the moment.
`IconViewModel`	`getModel()`
`protected List`	`getNextPathInHistory()`
`List`	`getPath()`
`String`	`getPathString()`
`protected List`	`getPreviousPathInHistory()`
`IconChip`	`getUpFolderIconChip()`
`void`	`gotoPath(String path)`
`protected boolean`	`hasNextPathInHistory()`
`protected boolean`	`hasPreviousPathInHistory()`
`protected List`	`matchPaths(Object parent, List tokens, int level)`
`protected List`	`matchPaths(String pathQuery)`
`protected void`	`notifyPathChanged()`
`void`	`open(Object element)` Opens a selected element.
`void`	`processAjaxEvents(HttpServletRequest request, HttpServletResponse response, PrintWriter out, Map requestParameters)`
`protected boolean`	`processContextMenuEvents(Map allEvents)`
`void`	`processEvents(Map events)` Handles all incoming requests for this chip.
`protected void`	`removeNextFromHistory()`
`void`	`setPath(List newPath)` Changes the current path completely.
`protected List`	`tokenizePath(String pathStr)`
`protected List`	`translatePathString(String pathStr)`
`protected void`	`trimHistoryToSize()`
`protected String`	`trimToSize(String path)`
`void`	`up()`

Methods inherited from class de.hybris.platform.hmc.webchips.AbstractChip
addEventListener, checkValid, clearInfoMessages, clone, containsDisplayEvent, createMenuEntriesForJS, dispose, errorQueueEmpty, getClipboard, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getFrame, getID, getInfoMessages, getJaloSession, getLocalizedString, getLocalizedString, getLogger, getNameSpace, getNameSpaceFor, getParent, getProposedUniqueName, getProposedUniqueNameFor, getRequestFocus, getSessionIdentifier, getStringValue, getUniqueName, getWindow, goFullScreen, hasVisibleContextMenuEntries, isButtonPushed, isButtonPushed, isErrorQueueEmpty, isValid, leaveFullScreen, notifyEventListeners, notifyEventListeners, postErrorMessage, postInfoMessage, postWindowEvent, refresh, refreshChild, registerUniqueName, removeEventListener, removeInfoMessage, render, render, setClipboard, setParent, setRequestFocus, setValid, setWindowStatus, translateFormFieldToEventName, translateFormFieldToEventValue

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UNAVAILABLE_ICON
```
public static final String UNAVAILABLE_ICON
```
    See Also:
    
    Constant Field Values
  - UNKNOWN_ICON
```
public static final String UNKNOWN_ICON
```
    See Also:
    
    Constant Field Values
  - FOLDER_ICON
```
public static final String FOLDER_ICON
```
    See Also:
    
    Constant Field Values
  - EDIT
```
public static final String EDIT
```
    See Also:
    
    Constant Field Values
  - REMOVE
```
public static final String REMOVE
```
    See Also:
    
    Constant Field Values
  - COPY
```
public static final String COPY
```
    See Also:
    
    Constant Field Values
  - GOTO
```
public static final String GOTO
```
    See Also:
    
    Constant Field Values
  - PATH
```
public static final String PATH
```
    See Also:
    
    Constant Field Values
  - UP
```
public static final String UP
```
    See Also:
    
    Constant Field Values
  - AJAX_INPUT
```
public static final String AJAX_INPUT
```
    See Also:
    
    Constant Field Values
  - AJAX_RESULT
```
public static final String AJAX_RESULT
```
    See Also:
    
    Constant Field Values
  - AJAX_QUERY
```
public static final String AJAX_QUERY
```
    See Also:
    
    Constant Field Values
  - AJAX_COUNT
```
public static final String AJAX_COUNT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IconViewChip
```
public IconViewChip(DisplayState displayState,
                    Chip parent,
                    IconViewModel model)
```
    Creates a new IconViewChip.
    
    Parameters:
    
    displayState - the current display state
    
    parent - the parent chip
    
    model - the data model for this view chip
- Method Detail
  - getModel
```
public IconViewModel getModel()
```
    Returns:
    
    the data model of this chip.
  - getPath
```
public List getPath()
```
    Returns:
    
    the current path of selected elements. The last elements provides all subelements which are currently displayed.
  - getPathString
```
public String getPathString()
```
  - tokenizePath
```
protected List tokenizePath(String pathStr)
                     throws IllegalArgumentException
```
    Throws:
    
    IllegalArgumentException
  - translatePathString
```
protected List translatePathString(String pathStr)
                            throws IllegalArgumentException
```
    Throws:
    
    IllegalArgumentException
  - matchPaths
```
protected List matchPaths(String pathQuery)
```
  - matchPaths
```
protected List matchPaths(Object parent,
                          List tokens,
                          int level)
```
  - getCurrentElement
```
public Object getCurrentElement()
```
    Returns:
    
    the parent element 9of all currently displayed elements.
  - getElements
```
public List getElements()
```
    Returns all curretly displayable elements. Please call this method instead of IconViewModel.getElements(Object) directly - otherwise actions will not work!
  - getUpFolderIconChip
```
public IconChip getUpFolderIconChip()
```
  - getElementChips
```
public List getElementChips()
```
  - getPreviousPathInHistory
```
protected List getPreviousPathInHistory()
```
  - hasPreviousPathInHistory
```
protected boolean hasPreviousPathInHistory()
```
  - getNextPathInHistory
```
protected List getNextPathInHistory()
```
  - hasNextPathInHistory
```
protected boolean hasNextPathInHistory()
```
  - addPathToHistory
```
protected void addPathToHistory(List path)
```
  - removeNextFromHistory
```
protected void removeNextFromHistory()
```
  - trimHistoryToSize
```
protected void trimHistoryToSize()
```
  - addToPath
```
protected void addToPath(Object element)
```
    Expands the path by the selected element.
    
    Parameters:
    
    element - the selected element.
  - notifyPathChanged
```
protected void notifyPathChanged()
```
  - cutPathTo
```
protected void cutPathTo(Object element)
```
    Cuts the selection path down to the specified element.
    
    Parameters:
    
    element - the element to go back to; if null the path is cleared completely
  - processAjaxEvents
```
public void processAjaxEvents(HttpServletRequest request,
                              HttpServletResponse response,
                              PrintWriter out,
                              Map requestParameters)
```
    Specified by:
    
    processAjaxEvents in interface AjaxRequestHandler
  - getAutoCompleter
```
public AutoCompleterComponent getAutoCompleter()
```
  - trimToSize
```
protected String trimToSize(String path)
```
  - gotoPath
```
public void gotoPath(String path)
```
  - up
```
public void up()
```
  - processEvents
```
public void processEvents(Map events)
```
    Description copied from interface: Chip
    
    Handles all incoming requests for this chip. Map contains name (String) and value (List of Strings)
    
    Specified by:
    
    processEvents in interface Chip
  - getMenuEntries
```
public List getMenuEntries()
```
    Description copied from class: AbstractChip
    
    Here you can specify what Actions you are able to perform at the moment. Should be overridden in sub classes.
    
    Specified by:
    
    getMenuEntries in interface Chip
    
    Overrides:
    
    getMenuEntries in class AbstractChip
    
    Returns:
    
    List of Actions;
  - processContextMenuEvents
```
protected boolean processContextMenuEvents(Map allEvents)
```
  - getJSPURI
```
public String getJSPURI()
```
    Description copied from interface: Chip
    
    Returns the URI of the JSP that this chip wants to use.
    
    Specified by:
    
    getJSPURI in interface Chip
    
    See Also:
    
    Chip.getJSPURI()
  - open
```
public void open(Object element)
```
    Opens a selected element. The next time the chip is rendered its subelements are displayed. The element is appeded to the path.
    
    Parameters:
    
    element - the selected element
  - backTo
```
public void backTo(Object element)
```
    Goes back to the specified element. The next time the chip is rendered its subelements are displayed. The path is cut down to this element.
    
    Parameters:
    
    element - the (path)element to go back to
  - back
```
public void back()
```
    Goes back one element of the current path. If the path is empty nothing happens.
  - forward
```
public void forward()
```
  - canGoBack
```
public boolean canGoBack()
```
    Returns:
    
    true if there is at least one element opened.
  - canGoForward
```
public boolean canGoForward()
```
  - setPath
```
public void setPath(List newPath)
```
    Changes the current path completely.
    
    Parameters:
    
    newPath -

Class IconViewChip

Field Summary

Fields inherited from class de.hybris.platform.hmc.webchips.AbstractChip

Fields inherited from interface de.hybris.platform.hmc.webchips.Chip

Constructor Summary

Method Summary

Methods inherited from class de.hybris.platform.hmc.webchips.AbstractChip

Methods inherited from class java.lang.Object

Field Detail

UNAVAILABLE_ICON

UNKNOWN_ICON

FOLDER_ICON

EDIT

REMOVE

COPY

GOTO

PATH

UP

AJAX_INPUT

AJAX_RESULT

AJAX_QUERY

AJAX_COUNT

Constructor Detail

IconViewChip

Method Detail

getModel

getPath

getPathString

tokenizePath

translatePathString

matchPaths

matchPaths

getCurrentElement

getElements

getUpFolderIconChip

getElementChips

getPreviousPathInHistory

hasPreviousPathInHistory

getNextPathInHistory

hasNextPathInHistory

addPathToHistory

removeNextFromHistory

trimHistoryToSize

addToPath

notifyPathChanged

cutPathTo

processAjaxEvents

getAutoCompleter

trimToSize

gotoPath

up

processEvents

getMenuEntries

processContextMenuEvents

getJSPURI

open

backTo

back

forward

canGoBack

canGoForward

setPath