ExplorerChip (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

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

All Implemented Interfaces:

DisplayRequestHandler, SearchRequestHandler, Chip, ExtraParamHandler, Serializable, Cloneable
```
public class ExplorerChip
extends AbstractChip
implements DisplayRequestHandler, SearchRequestHandler, ExtraParamHandler
```
This is a explorer

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ExplorerChip.ContentDockingListener` A chip has to implement this interface if it will be notfied as being removed, hidden or as being shown.

Field Summary

Fields
Modifier and Type Field and Description

static String EXPLORER_CHIP_ID

protected ItemHistoryChip itemHistoryChip

static String KEY
- 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

Fields
Modifier and Type	Field and Description
`static String`	`EXPLORER_CHIP_ID`
`protected ItemHistoryChip`	`itemHistoryChip`
`static String`	`KEY`

Constructor Summary

Constructors
Constructor and Description

ExplorerChip(DisplayState displayState, Chip parent)

Constructors
Constructor and Description
`ExplorerChip(DisplayState displayState, Chip parent)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addOrganizer(OrganizerChip organizer)`
`void`	`back()` Calls `GenericExplorerMenuTreeNodeContentChip.back()`.
`boolean`	`canGoBack()`
`boolean`	`canGoForward()`
`boolean`	`canHandleRequest(DisplayRequest request)`
`boolean`	`canHandleRequest(SearchRequest request)` Implementation of SearchRequestHandler interface.
`protected void`	`changeContent(Chip chip)` Changes current content without registering the new chip in the history.
`void`	`checkValid()` Gives the child chips (toolbar & tree) the possibility to check if its objects are still valid.
`protected void`	`configureToolbar()`
`protected void`	`createSockets()`
`boolean`	`existsOrganizer(ComposedType composedType)`
`void`	`forward()`
`Chip`	`getContent()`
`SocketChip`	`getContentSocket()` Gets the socket for content.
`static ExplorerChip`	`getCurrentExplorerChip(DisplayState displayState)`
`protected Chip`	`getDefaultContent()`
`String`	`getDisplayParameters()` The default implementation returns `Null` since this feature is not supported by default.
`String`	`getFrameID()`
`ItemHistoryChip`	`getItemHistoryChip()`
`String`	`getJSPURI()` Returns the URI of the JSP that this chip wants to use.
`protected GenericExplorerMenuTreeNodeContentChip`	`getMenuContentChip()`
`OrganizerChip`	`getOrganizer(ComposedType composedType)`
`OrganizerChip`	`getOrganizer(ComposedType composedType, boolean allowSubTypeOrganizer)`
`protected String`	`getSessionInfoTitle()`
`String`	`getTitle()`
`Chip`	`getToolbar()`
`Chip`	`getTree()`
`void`	`handleExtraParams(Map extraParams)` Handles extra parameters given via url ("open", "search",...).
`void`	`handleRequest(DisplayRequest request)`
`void`	`handleRequest(SearchRequest request)` Implementation of SearchRequestHandler interface.
`void`	`home()`
`protected void`	`notifyContentRemoval(Chip removedFromContent)`
`protected void`	`notifyContentShown(Chip shownAsContent)`
`void`	`processDisplayParameters(String parameters)`
`void`	`processEvents(Map<String,List<String>> events)` Handles all incoming requests for this chip.
`void`	`refresh()` Does nothing right now.
`void`	`removeOrganizer(OrganizerChip organizer)`
`void`	`setContent(Chip chip)` Changes the explorer content.
`void`	`setDefaultContent()` Shows the default content.
`OrganizerChip`	`setOrganizer(ComposedType forType)`
`OrganizerChip`	`setOrganizer(ComposedType forType, boolean allowSubTypeOrganizer)`
`void`	`setToolbar(Chip chip)`
`void`	`setTree(Chip chip)`
`boolean`	`showItemHistoryChip()`

Methods inherited from class de.hybris.platform.hmc.webchips.AbstractChip
addEventListener, clearInfoMessages, clone, containsDisplayEvent, createMenuEntriesForJS, dispose, errorQueueEmpty, getClipboard, getCommandID, getDisplayState, getEventID, getEventURL, getEventValue, getFrame, getID, getInfoMessages, getJaloSession, getLocalizedString, getLocalizedString, getLogger, getMenuEntries, getNameSpace, getNameSpaceFor, getParent, getProposedUniqueName, getProposedUniqueNameFor, getRequestFocus, getSessionIdentifier, getStringValue, getUniqueName, getWindow, goFullScreen, hasVisibleContextMenuEntries, isButtonPushed, isButtonPushed, isErrorQueueEmpty, isValid, leaveFullScreen, notifyEventListeners, notifyEventListeners, postErrorMessage, postInfoMessage, postWindowEvent, 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
  - KEY
```
public static final String KEY
```
    See Also:
    
    Constant Field Values
  - EXPLORER_CHIP_ID
```
public static final String EXPLORER_CHIP_ID
```
    See Also:
    
    Constant Field Values
  - itemHistoryChip
```
protected ItemHistoryChip itemHistoryChip
```
- Constructor Detail
  - ExplorerChip
```
public ExplorerChip(DisplayState displayState,
                    Chip parent)
```
- Method Detail
  - getCurrentExplorerChip
```
public static final ExplorerChip getCurrentExplorerChip(DisplayState displayState)
```
  - createSockets
```
protected void createSockets()
```
  - configureToolbar
```
protected void configureToolbar()
```
  - refresh
```
public void refresh()
```
    Does nothing right now.
    
    Overrides:
    
    refresh in class AbstractChip
  - home
```
public void home()
```
  - back
```
public void back()
```
    Calls GenericExplorerMenuTreeNodeContentChip.back().
  - canGoBack
```
public boolean canGoBack()
```
  - forward
```
public void forward()
```
  - canGoForward
```
public boolean canGoForward()
```
  - getMenuContentChip
```
protected GenericExplorerMenuTreeNodeContentChip getMenuContentChip()
```
  - getDefaultContent
```
protected Chip getDefaultContent()
```
  - setToolbar
```
public void setToolbar(Chip chip)
```
  - getToolbar
```
public Chip getToolbar()
```
  - notifyContentRemoval
```
protected void notifyContentRemoval(Chip removedFromContent)
```
  - notifyContentShown
```
protected void notifyContentShown(Chip shownAsContent)
```
  - changeContent
```
protected void changeContent(Chip chip)
```
    Changes current content without registering the new chip in the history.
    
    Parameters:
    
    chip -
  - setContent
```
public void setContent(Chip chip)
```
    Changes the explorer content.
    If previous chip is a instance of ExplorerChip.ContentDockingListener it will be notfied as being removed or hidden. If the new chip is a instance of ExplorerChip.ContentDockingListener it is notfied as being shown.
    The new chip is registered in the explorer history.
    
    Parameters:
    
    chip -
  - setDefaultContent
```
public void setDefaultContent()
```
    Shows the default content.
  - getContent
```
public Chip getContent()
```
  - getContentSocket
```
public SocketChip getContentSocket()
```
    Gets the socket for content. If you want to set content to the explorer, please use setContent(Chip) instead of setting the plugin directly to the socket.
  - setTree
```
public void setTree(Chip chip)
```
  - getTree
```
public Chip getTree()
```
  - getItemHistoryChip
```
public ItemHistoryChip getItemHistoryChip()
```
    Since:
    
    3.00 (beta1)
  - showItemHistoryChip
```
public boolean showItemHistoryChip()
```
    Since:
    
    3.00 (beta1)
  - processEvents
```
public void processEvents(Map<String,List<String>> 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
  - 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
  - checkValid
```
public void checkValid()
```
    Gives the child chips (toolbar & tree) the possibility to check if its objects are still valid. A validation check for the content chip is not necessary because it is the display chip of the leaf node chips in the tree and therefore it already will be checked at this way.
    
    Specified by:
    
    checkValid in interface Chip
    
    Overrides:
    
    checkValid in class AbstractChip
  - getTitle
```
public String getTitle()
```
  - getSessionInfoTitle
```
protected String getSessionInfoTitle()
```
  - getFrameID
```
public String getFrameID()
```
  - setOrganizer
```
public OrganizerChip setOrganizer(ComposedType forType,
                                  boolean allowSubTypeOrganizer)
```
    Since:
    
    3.0 M2
  - setOrganizer
```
public OrganizerChip setOrganizer(ComposedType forType)
```
  - getOrganizer
```
public OrganizerChip getOrganizer(ComposedType composedType)
```
  - getOrganizer
```
public OrganizerChip getOrganizer(ComposedType composedType,
                                  boolean allowSubTypeOrganizer)
```
    Since:
    
    3.0 M2
  - addOrganizer
```
public void addOrganizer(OrganizerChip organizer)
```
  - removeOrganizer
```
public void removeOrganizer(OrganizerChip organizer)
```
  - existsOrganizer
```
public boolean existsOrganizer(ComposedType composedType)
```
  - canHandleRequest
```
public boolean canHandleRequest(DisplayRequest request)
```
    Specified by:
    
    canHandleRequest in interface DisplayRequestHandler
  - handleRequest
```
public void handleRequest(DisplayRequest request)
```
    Specified by:
    
    handleRequest in interface DisplayRequestHandler
  - canHandleRequest
```
public boolean canHandleRequest(SearchRequest request)
```
    Implementation of SearchRequestHandler interface. Returns true if the tree component can handle the request.
    
    Specified by:
    
    canHandleRequest in interface SearchRequestHandler
    
    Parameters:
    
    request - the SearchRequest to be handled
    
    Returns:
    
    true if the tree component can handle the request.
    
    Since:
    
    1.3.1
  - handleRequest
```
public void handleRequest(SearchRequest request)
```
    Implementation of SearchRequestHandler interface. Delegates the request to the tree component (if it can handle the request).
    
    Specified by:
    
    handleRequest in interface SearchRequestHandler
    
    Parameters:
    
    request - the SearchRequest to be handled
    
    Since:
    
    1.3.1
  - getDisplayParameters
```
public String getDisplayParameters()
```
    Description copied from class: AbstractChip
    
    The default implementation returns Null since this feature is not supported by default.
    
    Specified by:
    
    getDisplayParameters in interface Chip
    
    Overrides:
    
    getDisplayParameters in class AbstractChip
    
    Returns:
    
    Parameters the chip needs to restore its current display status. Currently these parameters are used by the PRG (Post-Redirect-Get Pattern) request, if the user uses back-functionality of the browser.
    
    See Also:
    
    Chip.getDisplayParameters()
  - processDisplayParameters
```
public void processDisplayParameters(String parameters)
```
  - handleExtraParams
```
public void handleExtraParams(Map extraParams)
```
    Handles extra parameters given via url ("open", "search",...).
    
    Specified by:
    
    handleExtraParams in interface ExtraParamHandler

Class ExplorerChip

Nested Class Summary

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

KEY

EXPLORER_CHIP_ID

itemHistoryChip

Constructor Detail

ExplorerChip

Method Detail

getCurrentExplorerChip

createSockets

configureToolbar

refresh

home

back

canGoBack

forward

canGoForward

getMenuContentChip

getDefaultContent

setToolbar

getToolbar

notifyContentRemoval

notifyContentShown

changeContent

setContent

setDefaultContent

getContent

getContentSocket

setTree

getTree

getItemHistoryChip

showItemHistoryChip

processEvents

getJSPURI

checkValid

getTitle

getSessionInfoTitle

getFrameID

setOrganizer

setOrganizer

getOrganizer

getOrganizer

addOrganizer

removeOrganizer

existsOrganizer

canHandleRequest

handleRequest

canHandleRequest

handleRequest

getDisplayParameters

processDisplayParameters

handleExtraParams