de.hybris.platform.hmc.generic

Class GenericItemChip.GenericWizardEditorContext

java.lang.Object

de.hybris.platform.hmc.HMCHelper.DefaultHMCContext

de.hybris.platform.hmc.generic.GenericItemChip.GenericItemEditorContext

de.hybris.platform.hmc.generic.GenericItemChip.GenericWizardEditorContext

All Implemented Interfaces:

HMCContext, ItemEditorContext, WizardEditorContext, Serializable

Enclosing class:

GenericItemChip

protected class GenericItemChip.GenericWizardEditorContext
extends GenericItemChip.GenericItemEditorContext
implements WizardEditorContext

The editor context implementation for wizard items. It provides additional methods for user interaction and process visualization.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenericWizardEditorContext()

Method Summary

Modifier and Type	Method and Description
void	disableButton(String buttonName) Implementation of WizardEditorContext interface.
void	enableButton(String buttonName) Implementation of WizardEditorContext interface.
List	getSelectedValues(String fieldName) Returns all selected values of the specified attribute editor.
void	hideButton(String buttonName) Implementation of WizardEditorContext interface.
void	hideField(String fieldName) Marks an editor field as hidden.
void	hideTab(String tabName) Hides a specified tab.
void	reloadAllFields() Reloads all field data from the underlying wizard item.
void	reloadField(String field) Reloads the field data from the underlying wizard item.
void	reloadFields(Collection fields) Reloads a given set of field data from the underlying wizard item.
void	setButtonLabel(String buttonName, String buttonLabelKey) Implementation of WizardEditorContext interface.
void	setProcessingMode(boolean processingMode) Implementation of WizardEditorContext interface.
void	setRefreshInterval(int seconds) Changes the refresh period.
void	setSelectedValues(String fieldName, List newSelectedValues) Changes the currently selected values within the editor of a specified field.
void	setStatus(String status, int percentage, boolean error) Implementation of WizardEditorContext interface.
void	showButton(String buttonName) Implementation of WizardEditorContext interface.
void	showErrorMessage(String errorMessage) Shows an error message containing the given message text.
void	showErrorTab(String errorMessage) Shows the error tab containing the given message text.
void	showField(String fieldName) Marks an editor field as visible.
void	showInfoMessage(String infoMessage) Shows an info message containing the given message text.
void	showInfoTab(String infoMessage) Shows the info tab containing the given message text.
void	showSummaryTab(String summaryMessage) Shows the summary tab containing the given message text.
void	showTab(String tabName) Shows a specified tab.

Methods inherited from class de.hybris.platform.hmc.generic.GenericItemChip.GenericItemEditorContext

clearAllErrors, clearAllInfoMessages, clearError, close, getAttributeChip, getCurrentTab, getCurrentValue, getDescription, getEditorFields, getItemType, getPendingInfoMessages, getTabChip, isEditable, isOptional, nextTab, postInfoMessage, previousTab, removeInfoMessage, setCurrentTab, setCurrentValue, setDescription, setEditable, setInitialValue, setOptional, showError

Methods inherited from class de.hybris.platform.hmc.HMCHelper.DefaultHMCContext

canOpenWizard, expandNode, findOrganizer, getChip, openItem, openOrganizer, openType, openType, openTypeAndSearch, openWizard, openWizard

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.hybris.platform.hmc.jalo.ItemEditorContext

clearAllErrors, clearAllInfoMessages, clearError, close, getCurrentTab, getCurrentValue, getDescription, getEditorFields, getItemType, getPendingInfoMessages, isEditable, isOptional, nextTab, postInfoMessage, previousTab, removeInfoMessage, setCurrentTab, setCurrentValue, setDescription, setEditable, setInitialValue, setOptional, showError

Methods inherited from interface de.hybris.platform.hmc.jalo.HMCContext

canOpenWizard, expandNode, openItem, openType, openType, openTypeAndSearch, openWizard, openWizard

Constructor Detail

GenericWizardEditorContext

protected GenericWizardEditorContext()

Method Detail

getSelectedValues

public List getSelectedValues(String fieldName)
                       throws JaloInvalidParameterException

Description copied from interface: WizardEditorContext

Returns all selected values of the specified attribute editor.

Specified by:

getSelectedValues in interface WizardEditorContext

Throws:

JaloInvalidParameterException - if either the editor does not own the field at all, or the editor does not support selection.

setSelectedValues

public void setSelectedValues(String fieldName,
                              List newSelectedValues)
                       throws JaloInvalidParameterException

Description copied from interface: WizardEditorContext

Changes the currently selected values within the editor of a specified field.

Specified by:

setSelectedValues in interface WizardEditorContext

Throws:

JaloInvalidParameterException - if either the editor does not own the field at all, the editor does not support selection or one of the new selected values are currently not hold by the editor.

hideField

public void hideField(String fieldName)
               throws JaloInvalidParameterException

Description copied from interface: WizardEditorContext

Marks an editor field as hidden. The GUI will hide it the next time the wizard is rendered. The field's value(s) are not deleted!

Specified by:

hideField in interface WizardEditorContext

Throws:

JaloInvalidParameterException - if no field with the specified name exists

showField

public void showField(String fieldName)
               throws JaloInvalidParameterException

Description copied from interface: WizardEditorContext

Marks an editor field as visible. The GUI will show it the next time the wizard is rendered.

Specified by:

showField in interface WizardEditorContext

Throws:

JaloInvalidParameterException - if no field with the specified name exists

hideTab

public void hideTab(String tabName)
             throws JaloInvalidParameterException

Description copied from interface: WizardEditorContext

Hides a specified tab. The currently active tab cannot be hidden.

Specified by:

hideTab in interface WizardEditorContext

Throws:

JaloInvalidParameterException - if the tab is currently shown or no such tab exists.

showTab

public void showTab(String tabName)

Description copied from interface: WizardEditorContext

Shows a specified tab. The tab is visible but not active - use ItemEditorContext.setCurrentTab(String) to activate it.

Specified by:

showTab in interface WizardEditorContext

hideButton

public void hideButton(String buttonName)

Implementation of WizardEditorContext interface.

Specified by:

hideButton in interface WizardEditorContext

See Also:

WizardEditorContext.hideButton(String)

showButton

public void showButton(String buttonName)

Implementation of WizardEditorContext interface.

Specified by:

showButton in interface WizardEditorContext

See Also:

WizardEditorContext.showButton(String)

enableButton

public void enableButton(String buttonName)

Implementation of WizardEditorContext interface.

Specified by:

enableButton in interface WizardEditorContext

See Also:

WizardEditorContext.enableButton(String)

disableButton

public void disableButton(String buttonName)

Implementation of WizardEditorContext interface.

Specified by:

disableButton in interface WizardEditorContext

See Also:

WizardEditorContext.disableButton(String)

setButtonLabel

public void setButtonLabel(String buttonName,
                           String buttonLabelKey)

Implementation of WizardEditorContext interface.

Specified by:

setButtonLabel in interface WizardEditorContext

See Also:

WizardEditorContext.setButtonLabel(String, String)

setRefreshInterval

public void setRefreshInterval(int seconds)

Description copied from interface: WizardEditorContext

Changes the refresh period. This is the amount of seconds which the wizard GUI will wait until it polls the current status via WizardBusinessItem.pollStatus(WizardEditorContext) in process mode.

Specified by:

setRefreshInterval in interface WizardEditorContext

setProcessingMode

public void setProcessingMode(boolean processingMode)

Implementation of WizardEditorContext interface.

Specified by:

setProcessingMode in interface WizardEditorContext

Parameters:

processingMode - if true the wizard is showing and polling processing information

See Also:

WizardEditorContext.setProcessingMode(boolean)

setStatus

public void setStatus(String status,
                      int percentage,
                      boolean error)

Implementation of WizardEditorContext interface.

Specified by:

setStatus in interface WizardEditorContext

Parameters:

status - a status text

percentage - the completion level from [0, 100]

See Also:

WizardEditorContext.setStatus(String, int, boolean)

reloadAllFields

public void reloadAllFields()

Description copied from interface: WizardEditorContext

Reloads all field data from the underlying wizard item. Any changes held by the field editors are discarded.

Specified by:

reloadAllFields in interface WizardEditorContext

reloadField

public void reloadField(String field)

Description copied from interface: WizardEditorContext

Reloads the field data from the underlying wizard item. Any changes held by the field editors are discarded.

Specified by:

reloadField in interface WizardEditorContext

Parameters:

field - the field to reload

reloadFields

public void reloadFields(Collection fields)

Description copied from interface: WizardEditorContext

Reloads a given set of field data from the underlying wizard item. Any changes held by the field editors are discarded.

Specified by:

reloadFields in interface WizardEditorContext

showInfoTab

public void showInfoTab(String infoMessage)

Shows the info tab containing the given message text.

Specified by:

showInfoTab in interface WizardEditorContext

Parameters:

infoMessage -

showErrorTab

public void showErrorTab(String errorMessage)

Shows the error tab containing the given message text.

Specified by:

showErrorTab in interface WizardEditorContext

Parameters:

errorMessage -

showSummaryTab

public void showSummaryTab(String summaryMessage)

Shows the summary tab containing the given message text.

Specified by:

showSummaryTab in interface WizardEditorContext

Parameters:

summaryMessage -

showInfoMessage

public void showInfoMessage(String infoMessage)

Shows an info message containing the given message text.

Specified by:

showInfoMessage in interface WizardEditorContext

Parameters:

infoMessage -

showErrorMessage

public void showErrorMessage(String errorMessage)

Shows an error message containing the given message text.

Specified by:

showErrorMessage in interface WizardEditorContext

Parameters:

errorMessage -