de.hybris.platform.hmc.generic.organizer

Class AbstractOrganizerChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

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

All Implemented Interfaces:

DisplayRequestHandler, SearchRequestHandler, TypedChip, Chip, Serializable, Cloneable

Direct Known Subclasses:

OrganizerChip

public abstract class AbstractOrganizerChip
extends AbstractChip
implements TypedChip, DisplayRequestHandler, SearchRequestHandler

Abstract base class of organizes.

See Also:

Serialized Form

Field Summary

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
AbstractOrganizerChip(DisplayState displayState, Chip parent, ComposedType type, boolean considerSubtypes, Map lockedValues, Comparator comparator)
AbstractOrganizerChip(DisplayState displayState, Chip parent, ComposedType type, Map lockedValues)

Method Summary

Modifier and Type	Method and Description
void	addComponentChip(OrganizerComponentChip chip)
boolean	canHandleRequest(DisplayRequest request)
boolean	canHandleRequest(SearchRequest request) Implementation of SearchRequestHandler interface.
void	checkValid() Gives the chip the possibility to check if its objects are still valid.
boolean	containsEditor(Item item)
protected OrganizerItemChip	createEditor(Chip parent, Item item)
protected void	edit(Item item)
protected void	edit(Item item, String tabName)
protected void	editNext(Item item) Sets the editor to the next item after the given one.
protected void	editPrevious(Item item) Sets the editor to the previous item before the given one.
OrganizerComponentChip	getActiveComponentChip()
protected Comparator	getComparator()
List	getComponentChips()
OrganizerComponentChip	getCreatorComponent()
String	getDisplayParameters() The default implementation returns Null since this feature is not supported by default.
OrganizerComponentChip	getEditorComponent()
ComposedType	getItemType()
abstract GenericItemListChip	getListChip()
Map	getLockedValues()
GenericItemChip	getOrCreateEditor(Item item)
OrganizerComponentChip	getResultComponent()
OrganizerComponentChip	getSearchComponent()
String	getTitle()
void	handleRequest(DisplayRequest request)
void	handleRequest(SearchRequest request) Implementation of SearchRequestHandler interface.
protected boolean	hasNext(Item item)
protected boolean	hasPrevious(Item item)
protected void	initialize()
protected boolean	isChanged()
protected boolean	isChanged(Item item)
protected boolean	isConsiderSubtypes() Returns true if subtypes should be considered when creating an item
boolean	isPartOf()
protected boolean	isSelected(Item item)
void	processDisplayParameters(String parameters)
abstract void	reload()
protected void	removeAllEditors()
void	removeEditor(Item item)
protected void	saveAll()
void	setActiveComponentChip(OrganizerComponentChip component)
void	setCreatorComponent(OrganizerComponentChip creatorHolder)
void	setPartOf(boolean partOf)
void	setResultComponent(OrganizerComponentChip resultHolder)
void	setSearchComponent(OrganizerComponentChip searchHolder)
void	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, getJSPURI, getMenuEntries, getParent, getUniqueName, goFullScreen, isValid, leaveFullScreen, processEvents, registerUniqueName, removeEventListener, render, translateFormFieldToEventName, translateFormFieldToEventValue

Constructor Detail

AbstractOrganizerChip

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

AbstractOrganizerChip

public AbstractOrganizerChip(DisplayState displayState,
                             Chip parent,
                             ComposedType type,
                             Map lockedValues)

Method Detail

getComparator

protected Comparator getComparator()

initialize

protected void initialize()

checkValid

public void checkValid()

Description copied from class: AbstractChip

Gives the chip the possibility to check if its objects are still valid. If you override this method, call super.checkValid()

Specified by:

checkValid in interface Chip

Overrides:

checkValid in class AbstractChip

getItemType

public ComposedType getItemType()

Specified by:

getItemType in interface TypedChip

Returns:

The type bounded to this chip instance.

getLockedValues

public Map getLockedValues()

getActiveComponentChip

public OrganizerComponentChip getActiveComponentChip()

setActiveComponentChip

public void setActiveComponentChip(OrganizerComponentChip component)

getComponentChips

public List getComponentChips()

Returns:

List of Chips.

addComponentChip

public void addComponentChip(OrganizerComponentChip chip)

getTitle

public String getTitle()

Returns:

Localized title as given in the xml file.

edit

protected void edit(Item item,
                    String tabName)

Since:

2.30 beta

edit

protected void edit(Item item)

getEditorComponent

public OrganizerComponentChip getEditorComponent()

createEditor

protected OrganizerItemChip createEditor(Chip parent,
                                         Item item)

getListChip

public abstract GenericItemListChip getListChip()

editNext

protected void editNext(Item item)

Sets the editor to the next item after the given one.

hasNext

protected boolean hasNext(Item item)

editPrevious

protected void editPrevious(Item item)

Sets the editor to the previous item before the given one.

hasPrevious

protected boolean hasPrevious(Item item)

isChanged

protected boolean isChanged(Item item)

isChanged

protected boolean isChanged()

saveAll

protected void saveAll()

removeEditor

public void removeEditor(Item item)

getOrCreateEditor

public GenericItemChip getOrCreateEditor(Item item)

containsEditor

public boolean containsEditor(Item item)

Since:

3.00 (beta1)

removeAllEditors

protected void removeAllEditors()

isSelected

protected boolean isSelected(Item item)

reload

public abstract void reload()

showCreatorHolder

public void showCreatorHolder()

getResultComponent

public OrganizerComponentChip getResultComponent()

setResultComponent

public void setResultComponent(OrganizerComponentChip resultHolder)

getSearchComponent

public OrganizerComponentChip getSearchComponent()

setSearchComponent

public void setSearchComponent(OrganizerComponentChip searchHolder)

getCreatorComponent

public OrganizerComponentChip getCreatorComponent()

setCreatorComponent

public void setCreatorComponent(OrganizerComponentChip creatorHolder)

isPartOf

public boolean isPartOf()

setPartOf

public void setPartOf(boolean partOf)

Parameters:

partOf -

isConsiderSubtypes

protected boolean isConsiderSubtypes()

Returns true if subtypes should be considered when creating an item

Returns:

true if subtypes should be considered when creating an item

handleRequest

public void handleRequest(DisplayRequest request)

Specified by:

handleRequest in interface DisplayRequestHandler

canHandleRequest

public boolean canHandleRequest(DisplayRequest request)

Specified by:

canHandleRequest in interface DisplayRequestHandler

handleRequest

public void handleRequest(SearchRequest request)

Implementation of SearchRequestHandler interface. Handles the given search request by opening the appropriate search.

Specified by:

handleRequest in interface SearchRequestHandler

Parameters:

request - the SearchRequest to be handled

Since:

1.3.1

canHandleRequest

public boolean canHandleRequest(SearchRequest request)

Implementation of SearchRequestHandler interface. Is true if the search type of the given request matches the type of this organizer chip.

Specified by:

canHandleRequest in interface SearchRequestHandler

Parameters:

request - the SearchRequest to be handled

Returns:

true if the search type of the given request matches the type of this organizer chip.

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)