de.hybris.platform.hmc

Class AbstractEditorMenuChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.AbstractEditorMenuChip

All Implemented Interfaces:

Chip, Serializable, Cloneable

Direct Known Subclasses:

GenericEditorMenuChip

public abstract class AbstractEditorMenuChip
extends AbstractChip

This is an abstract class for EditorMenuChips. It handles displaying and selecting tabs including the extension tabs and displays the appropriate detail editors.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMIN_TAB_ID
static int	STATUS_ERROR
static int	STATUS_INFO
static int	STATUS_SUMMARY
static String	STATUS_TAB_ID

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
AbstractEditorMenuChip(DisplayState displayState, ItemChip parent)

Method Summary

Modifier and Type	Method and Description
boolean	canSelectTab(EditorTabChip tab) Tells whether a tab may be selected or not.
protected void	changeTab(EditorTabChip chipFrom, EditorTabChip chipTo)
void	checkValid() Gives the chip the possibility to check if its objects are still valid.
EditorTabChip	getActiveTab()
int	getActiveTabIndex()
List	getAllEditorTabChips()
List	getAllVisibleEditorTabChips()
ClipChip	getDetailEditor()
GenericEssentialsEditorChip	getEssentials() Delegates to ItemChip.getEssentials().
protected EditorTabChip	getInfoTabChip()
protected ItemChip	getItemChip() Returns the tab that precedes the currently active tab (or null if there is no previous tab).
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
protected int	getNextVisibleTabPosition()
protected int	getPreviousVisibleTabPosition()
protected EditorTabChip	getProcessingStatusTabChip()
EditorTabChip	getTabByName(String name) Tries to find the EditorTabChip with the given name (whether it is visible or not).
List	getTabGroups()
int	getTabIndex(EditorTabChip tab)
protected WizardInfoTabChip	getWizardInfoTabChip()
protected WizardStatusTabChip	getWizardStatusTabChip()
boolean	hasEssentials() Delegates to ItemChip.hasEssentials().
boolean	hasNextTab()
boolean	hasPreviousTab()
boolean	hideEssentials()
boolean	isInfoMode()
boolean	isNextTab(EditorTabChip tab)
boolean	isPartOf()
boolean	isPreviousTab(EditorTabChip tab)
boolean	isProcessingMode()
boolean	isVisible(EditorTabChip tabChip)
boolean	isWizard() Delegates to GenericItemChip.isWizard().
void	nextTab()
void	previousTab()
void	processEvents(Map events) Handles all incoming requests for this chip.
void	setActiveTab(EditorTabChip tabChip)
void	setActiveTab(int index)
void	setActiveTab(String name, int index) Tries to set the active tab by name.
void	setAllVisible()
void	setInfoMessage(String message) Sets the message of the info tab (which should already be localized and may contain html code).
void	setInfoMode(boolean mode)
void	setInfoStatus(int status) Sets the status of the info tab which is one of STATUS_INFO, STATUS_ERROR or STATUS_SUMMARY.
void	setInfoTabName(String name)
void	setPartOf(boolean partOf)
void	setProcessingMode(boolean inprocessingMode)
void	setProcessingStatus(String statusText, int percentage, boolean error)
void	setVisible(EditorTabChip tabChip, boolean visible)

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

addEventListener, clearInfoMessages, clone, containsDisplayEvent, createMenuEntriesForJS, dispose, errorQueueEmpty, getClipboard, getCommandID, getDisplayParameters, 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

Field Detail

ADMIN_TAB_ID

public static final String ADMIN_TAB_ID

See Also:

Constant Field Values

STATUS_TAB_ID

public static final String STATUS_TAB_ID

See Also:

Constant Field Values

STATUS_INFO

public static final int STATUS_INFO

See Also:

Constant Field Values

STATUS_ERROR

public static final int STATUS_ERROR

See Also:

Constant Field Values

STATUS_SUMMARY

public static final int STATUS_SUMMARY

See Also:

Constant Field Values

Constructor Detail

AbstractEditorMenuChip

public AbstractEditorMenuChip(DisplayState displayState,
                              ItemChip parent)

Method Detail

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)

setProcessingMode

public void setProcessingMode(boolean inprocessingMode)

isProcessingMode

public boolean isProcessingMode()

setProcessingStatus

public void setProcessingStatus(String statusText,
                                int percentage,
                                boolean error)

isInfoMode

public boolean isInfoMode()

setInfoMode

public void setInfoMode(boolean mode)

setInfoStatus

public void setInfoStatus(int status)

Sets the status of the info tab which is one of STATUS_INFO, STATUS_ERROR or STATUS_SUMMARY.

Parameters:

status - the status of the info tab (info, error or summary)

setInfoMessage

public void setInfoMessage(String message)

Sets the message of the info tab (which should already be localized and may contain html code).

Parameters:

message - the message to be shown on the info tab

getWizardStatusTabChip

protected WizardStatusTabChip getWizardStatusTabChip()

getProcessingStatusTabChip

protected EditorTabChip getProcessingStatusTabChip()

getWizardInfoTabChip

protected WizardInfoTabChip getWizardInfoTabChip()

getInfoTabChip

protected EditorTabChip getInfoTabChip()

setInfoTabName

public void setInfoTabName(String name)

getAllVisibleEditorTabChips

public final List getAllVisibleEditorTabChips()

isVisible

public boolean isVisible(EditorTabChip tabChip)

setVisible

public void setVisible(EditorTabChip tabChip,
                       boolean visible)

setAllVisible

public void setAllVisible()

getAllEditorTabChips

public final List getAllEditorTabChips()

getTabGroups

public List getTabGroups()

getJSPURI

public final String getJSPURI()

Description copied from interface: Chip

Returns the URI of the JSP that this chip wants to use.

getDetailEditor

public final ClipChip getDetailEditor()

nextTab

public void nextTab()

getNextVisibleTabPosition

protected int getNextVisibleTabPosition()

hasNextTab

public boolean hasNextTab()

isNextTab

public boolean isNextTab(EditorTabChip tab)

Since:

2.30

isPreviousTab

public boolean isPreviousTab(EditorTabChip tab)

Since:

2.30

getTabIndex

public int getTabIndex(EditorTabChip tab)

Since:

2.30

previousTab

public void previousTab()

getPreviousVisibleTabPosition

protected int getPreviousVisibleTabPosition()

hasPreviousTab

public boolean hasPreviousTab()

setActiveTab

public final void setActiveTab(int index)

setActiveTab

public final void setActiveTab(String name,
                               int index)

Tries to set the active tab by name. If no tab with the given name is found, the given index will be used as a fallback (setActiveTab(int)).

Since:

2.30

getTabByName

public EditorTabChip getTabByName(String name)

Tries to find the EditorTabChip with the given name (whether it is visible or not). Returns null if no tab with this name exists.

Returns:

the EditorTabChip with the given name or null if no tab with that name is found.

Since:

2.30

setActiveTab

public final void setActiveTab(EditorTabChip tabChip)

changeTab

protected void changeTab(EditorTabChip chipFrom,
                         EditorTabChip chipTo)

canSelectTab

public boolean canSelectTab(EditorTabChip tab)

Tells whether a tab may be selected or not. In normal mode, each tab except for the currently active tab is selectable. In wizard mode, each tab which is not the currently active tab and whose position is at the most recently processed tab position + 1 ( which means only the next unvisited tab or any previous tab ) is selectable.

Parameters:

tab - the tab to jump to

getActiveTabIndex

public final int getActiveTabIndex()

getActiveTab

public final EditorTabChip getActiveTab()

getItemChip

protected ItemChip getItemChip()

Returns the tab that precedes the currently active tab (or null if there is no previous tab).

Returns:

the tab that precedes the currently active tab (or null if there is no previous tab).

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

hideEssentials

public boolean hideEssentials()

Returns:

true if the current active tab is instance of TabChip and its TabChip.hideEssentials() method returns true

hasEssentials

public boolean hasEssentials()

Delegates to ItemChip.hasEssentials().

getEssentials

public GenericEssentialsEditorChip getEssentials()

Delegates to ItemChip.getEssentials().

isPartOf

public boolean isPartOf()

setPartOf

public void setPartOf(boolean partOf)

Parameters:

partOf -

isWizard

public boolean isWizard()

Delegates to GenericItemChip.isWizard().