de.hybris.platform.hmc.jalo

Interface WizardEditorContext

All Superinterfaces:

HMCContext, ItemEditorContext, Serializable

All Known Implementing Classes:

GenericItemChip.GenericWizardEditorContext

public interface WizardEditorContext
extends ItemEditorContext

The context given to a WizardBusinessItem which allows access to all editor fields and tabs.

Method Summary

Modifier and Type	Method and Description
void	disableButton(String buttonName) Disables a specified button.
void	enableButton(String buttonName) Enables a specified button.
List	getSelectedValues(String fieldName) Returns all selected values of the specified attribute editor.
void	hideButton(String buttonName) Hides a specified button.
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) Sets the label for the specified button, or rather the keys for which the appropriate localized string will be looked up.
void	setProcessingMode(boolean processing) Switches process mode on and off.
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) Changes the status text which is shown during process mode.
void	showButton(String buttonName) Shows a specified button.
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 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

Method Detail

reloadAllFields

void reloadAllFields()

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

reloadField

void reloadField(String field)

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

Parameters:

field - the field to reload

reloadFields

void reloadFields(Collection fields)

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

getSelectedValues

List getSelectedValues(String fieldName)
                throws JaloInvalidParameterException

Returns all selected values of the specified attribute editor.

Throws:

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

setSelectedValues

void setSelectedValues(String fieldName,
                       List newSelectedValues)
                throws JaloInvalidParameterException

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

Parameters:

fieldName -

newSelectedValues -

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

void hideField(String fieldName)
        throws JaloInvalidParameterException

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!

Parameters:

fieldName -

Throws:

JaloInvalidParameterException - if no field with the specified name exists

showField

void showField(String fieldName)
        throws JaloInvalidParameterException

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

Parameters:

fieldName -

Throws:

JaloInvalidParameterException - if no field with the specified name exists

hideTab

void hideTab(String tabName)
      throws JaloInvalidParameterException

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

Parameters:

tabName -

Throws:

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

showTab

void showTab(String tabName)

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

Parameters:

tabName -

Throws:

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

hideButton

void hideButton(String buttonName)

Hides a specified button. Usually, the buttonName is one of the constants WizardBusinessItem.BACK_BUTTON, WizardBusinessItem.NEXT_BUTTON or WizardBusinessItem.CANCEL_BUTTON. Note: If a button with the given name doesn't exist, nothing will happen.

Parameters:

buttonName -

showButton

void showButton(String buttonName)

Shows a specified button. Usually, the buttonName is one of the constants WizardBusinessItem.BACK_BUTTON, WizardBusinessItem.NEXT_BUTTON or WizardBusinessItem.CANCEL_BUTTON.
By default the button would be active unless specified otherwise using enableButton(String). Note: If a button with the given name doesn't exist, nothing will happen.

Parameters:

buttonName -

enableButton

void enableButton(String buttonName)

Enables a specified button. Usually, the buttonName is one of the constants WizardBusinessItem.BACK_BUTTON , WizardBusinessItem.NEXT_BUTTON or WizardBusinessItem.CANCEL_BUTTON.
As long as it wasn't specified using disableButton(String) a button would be enabled by default. Note: If a button with the given name doesn't exist, nothing will happen.

Parameters:

buttonName -

disableButton

void disableButton(String buttonName)

Disables a specified button. Usually, the buttonName is one of the constants WizardBusinessItem.BACK_BUTTON, WizardBusinessItem.NEXT_BUTTON or WizardBusinessItem.CANCEL_BUTTON.
Note: If a button with the given name doesn't exist, nothing will happen.

Parameters:

buttonName -

setButtonLabel

void setButtonLabel(String buttonName,
                    String buttonLabelKey)

Sets the label for the specified button, or rather the keys for which the appropriate localized string will be looked up. Usually, the buttonName is one of the constants WizardBusinessItem.BACK_BUTTON, WizardBusinessItem.NEXT_BUTTON or WizardBusinessItem.CANCEL_BUTTON.
The default label keys for these buttons are found in WizardBusinessItem.BACK_BUTTON_NAME, WizardBusinessItem.NEXT_BUTTON_NAME and WizardBusinessItem.CANCEL_BUTTON_NAME (which contain 'wizard.footer.back', 'wizard.footer.next' and 'wizard.footer.cancel'). Note: If a button with the given name doesn't exist, nothing will happen.

Parameters:

buttonName -

buttonLabelKey -

setRefreshInterval

void setRefreshInterval(int seconds)

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.

Parameters:

seconds -

setProcessingMode

void setProcessingMode(boolean processing)

Switches process mode on and off. During process mode, a special tab hides all input tabs and shows the wizard's status text and its completion provided via WizardBusinessItem.pollStatus(WizardEditorContext).

If process mode is switched off, the last active tab is shown again.

Parameters:

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

setStatus

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

Changes the status text which is shown during process mode. This method should be used within WizardBusinessItem.pollStatus(WizardEditorContext) to change the displayed status information.

Parameters:

status - a status text

percentage - the completion level from [0, 100]

error -

showInfoTab

void showInfoTab(String infoMessage)

Shows the info tab containing the given message text.

Parameters:

infoMessage -

showErrorTab

void showErrorTab(String errorMessage)

Shows the error tab containing the given message text.

Parameters:

errorMessage -

showSummaryTab

void showSummaryTab(String summaryMessage)

Shows the summary tab containing the given message text.

Parameters:

summaryMessage -

showInfoMessage

void showInfoMessage(String infoMessage)

Shows an info message containing the given message text.

Parameters:

infoMessage -

showErrorMessage

void showErrorMessage(String errorMessage)

Shows an error message containing the given message text.

Parameters:

errorMessage -