de.hybris.platform.hmc.generic.organizer

Class OrganizerChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.generic.organizer.AbstractOrganizerChip

de.hybris.platform.hmc.generic.organizer.OrganizerChip

All Implemented Interfaces:

DisplayRequestHandler, ExplorerChip.ContentDockingListener, ComposedTypeChangeListener, SearchRequestHandler, TypedChip, Chip, Serializable, Cloneable

Direct Known Subclasses:

WorkflowOrganizerChip

public class OrganizerChip
extends AbstractOrganizerChip
implements ExplorerChip.ContentDockingListener, ComposedTypeChangeListener

Generic SearchListChip which searches using a list of conditions.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLOSE

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
OrganizerChip(DisplayState displayState, Chip parent, ComposedType type, boolean considerSubtypes, GenericLeafNodeChip leafNodeChip, Map lockedValues)
OrganizerChip(DisplayState displayState, Chip parent, ComposedType type, boolean considerSubtypes, GenericLeafNodeChip leafNodeChip, Map lockedValues, Comparator comparator) OrganizerChips using a comparator will always show all elements (no range) and won't have the search tab
OrganizerChip(DisplayState displayState, Chip parent, ComposedType type, GenericLeafNodeChip leafNodeChip, Map lockedValues)
OrganizerChip(DisplayState displayState, Chip parent, ComposedType type, GenericLeafNodeChip leafNodeChip, Map lockedValues, Comparator comparator) OrganizerChips using a comparator will always show all elements (no range) and won't have the search tab

Method Summary

Modifier and Type	Method and Description
boolean	canDetach()
void	close()
void	composedTypeChanged(ComposedTypeChangeEvent event) Notifies this chip of a searchtype change.
void	contentHidden(ExplorerChip explorer) Is called each time when this chip has been showing as explorer content but is replaced by another chip.
void	contentRemoved(ExplorerChip explorer, boolean external) Called when this chip is no longer shown ( as explorer content or externally ) and is not re-used.
void	contentShown(ExplorerChip explorer, boolean external) Is called each time this chip is either shown as new explorer content or as external window organizer.
void	edit(Item item)
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
GenericItemListChip	getListChip()
OrganizerListChip	getResultListChip()
OrganizerSearchChip	getSearchChip()
AbstractToolbarChip	getToolbar()
Collection	getTypeEntries()
protected void	initialize()
void	processEvents(Map events) Handles all incoming requests for this chip.
void	reload()
void	search(AbstractSearchContainer searchContainer)
void	search(ComposedType type, SearchContext ctx) Deprecated. please use setSearchComponent
void	setToolbar(AbstractToolbarChip chip)

Methods inherited from class de.hybris.platform.hmc.generic.organizer.AbstractOrganizerChip

addComponentChip, canHandleRequest, canHandleRequest, checkValid, containsEditor, createEditor, edit, editNext, editPrevious, getActiveComponentChip, getComparator, getComponentChips, getCreatorComponent, getDisplayParameters, getEditorComponent, getItemType, getLockedValues, getOrCreateEditor, getResultComponent, getSearchComponent, getTitle, handleRequest, handleRequest, hasNext, hasPrevious, isChanged, isChanged, isConsiderSubtypes, isPartOf, isSelected, processDisplayParameters, removeAllEditors, removeEditor, saveAll, setActiveComponentChip, setCreatorComponent, setPartOf, setResultComponent, setSearchComponent, showCreatorHolder

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, 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

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

addEventListener, dispose, getCommandID, getDisplayState, getEventID, getEventURL, getEventValue, getID, getJaloSession, getMenuEntries, getParent, getUniqueName, goFullScreen, isValid, leaveFullScreen, registerUniqueName, removeEventListener, render, translateFormFieldToEventName, translateFormFieldToEventValue

Field Detail

CLOSE

public static final String CLOSE

See Also:

Constant Field Values

Constructor Detail

OrganizerChip

public OrganizerChip(DisplayState displayState,
                     Chip parent,
                     ComposedType type,
                     GenericLeafNodeChip leafNodeChip,
                     Map lockedValues)

Parameters:

leafNodeChip - if created by a LeafNodeChip (not in a new window)

lockedValues - values which can't be changed in the editor/creator

OrganizerChip

public OrganizerChip(DisplayState displayState,
                     Chip parent,
                     ComposedType type,
                     boolean considerSubtypes,
                     GenericLeafNodeChip leafNodeChip,
                     Map lockedValues)

Parameters:

leafNodeChip - if created by a LeafNodeChip (not in a new window)

lockedValues - values which can't be changed in the editor/creator

OrganizerChip

public OrganizerChip(DisplayState displayState,
                     Chip parent,
                     ComposedType type,
                     GenericLeafNodeChip leafNodeChip,
                     Map lockedValues,
                     Comparator comparator)

OrganizerChips using a comparator will always show all elements (no range) and won't have the search tab

Parameters:

leafNodeChip - if created by a LeafNodeChip (not in a new window)

lockedValues - values which can't be changed in the editor/creator

comparator - the comparator which will be used to sort the results

OrganizerChip

public OrganizerChip(DisplayState displayState,
                     Chip parent,
                     ComposedType type,
                     boolean considerSubtypes,
                     GenericLeafNodeChip leafNodeChip,
                     Map lockedValues,
                     Comparator comparator)

OrganizerChips using a comparator will always show all elements (no range) and won't have the search tab

Parameters:

leafNodeChip - if created by a LeafNodeChip (not in a new window)

lockedValues - values which can't be changed in the editor/creator

comparator - the comparator which will be used to sort the results

Method Detail

initialize

protected void initialize()

Overrides:

initialize in class AbstractOrganizerChip

getTypeEntries

public Collection getTypeEntries()

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

search

public void search(AbstractSearchContainer searchContainer)

search

@Deprecated
public void search(ComposedType type,
                               SearchContext ctx)

Deprecated. please use setSearchComponent

Parameters:

type -

ctx -

processEvents

public void processEvents(Map events)

Handles all incoming requests for this chip. Map contains name (String) and value (List of Strings)

Specified by:

processEvents in interface Chip

close

public void close()

canDetach

public boolean canDetach()

getResultListChip

public OrganizerListChip getResultListChip()

getSearchChip

public OrganizerSearchChip getSearchChip()

reload

public void reload()

Specified by:

reload in class AbstractOrganizerChip

edit

public void edit(Item item)

Overrides:

edit in class AbstractOrganizerChip

getListChip

public GenericItemListChip getListChip()

Specified by:

getListChip in class AbstractOrganizerChip

setToolbar

public final void setToolbar(AbstractToolbarChip chip)

getToolbar

public final AbstractToolbarChip getToolbar()

contentShown

public void contentShown(ExplorerChip explorer,
                         boolean external)

Description copied from interface: ExplorerChip.ContentDockingListener

Is called each time this chip is either shown as new explorer content or as external window organizer.

Specified by:

contentShown in interface ExplorerChip.ContentDockingListener

Parameters:

explorer - the explorer chip

external - whether or not this chip is shown within a window of its own

contentHidden

public void contentHidden(ExplorerChip explorer)

Description copied from interface: ExplorerChip.ContentDockingListener

Is called each time when this chip has been showing as explorer content but is replaced by another chip. Nevertheless this chip still exists and is kept by the explorer chip for later re-use.

Specified by:

contentHidden in interface ExplorerChip.ContentDockingListener

Parameters:

explorer - the explorer chip

contentRemoved

public void contentRemoved(ExplorerChip explorer,
                           boolean external)

Description copied from interface: ExplorerChip.ContentDockingListener

Called when this chip is no longer shown ( as explorer content or externally ) and is not re-used.

Specified by:

contentRemoved in interface ExplorerChip.ContentDockingListener

Parameters:

explorer - the explorer chip

external - whether or not this chip is shown within a window of its own

composedTypeChanged

public void composedTypeChanged(ComposedTypeChangeEvent event)

Notifies this chip of a searchtype change. The result section will then be closed/removed.

Specified by:

composedTypeChanged in interface ComposedTypeChangeListener

Since:

3.0 M2

See Also:

ComposedTypeChangeListener.composedTypeChanged(de.hybris.platform.hmc.generic.ComposedTypeChangeEvent)