de.hybris.platform.hmc.jalo

Interface ItemEditorContext

All Superinterfaces:

HMCContext, Serializable

All Known Subinterfaces:

WizardEditorContext

All Known Implementing Classes:

GenericItemChip.GenericItemEditorContext, GenericItemChip.GenericWizardEditorContext

public interface ItemEditorContext
extends HMCContext

Interface to a hmc item editor.

Method Summary

Modifier and Type	Method and Description
void	clearAllErrors() Resets error states of all fields to 'normal'.
void	clearAllInfoMessages() Removes all info messages from the message queue.
void	clearError(String fieldName) Resets the error state to 'normal'.
void	close()
String	getCurrentTab()
Object	getCurrentValue(String fieldName)
String	getDescription(String fieldName) Returns the current description of this field.
Set	getEditorFields()
ComposedType	getItemType()
List	getPendingInfoMessages() Returns all currently pending messages.
boolean	isEditable(String fieldName) Returns the editable state of the specified field.
boolean	isOptional(String fieldName) Returns the optional state of the specified field.
void	nextTab() Jumps to the next tab.
void	postInfoMessage(String msg) Posts an info message which is displayed as popoup.
void	previousTab() Jumps to the previous tab.
void	removeInfoMessage(int pos) Removes a single message from the current message queue.
void	setCurrentTab(String tabName) Jumps to a specified tab.
void	setCurrentValue(String fieldName, Object value) Changes the current editor value of the specified field.
void	setDescription(String fieldName, String descr) Changes the fields description.
void	setEditable(String fieldName, boolean enabled) Changes the editable state of the specified field.
void	setInitialValue(String fieldName, Object value) Changes the current editor value of the specified field.
void	setOptional(String fieldName, boolean optional) Changes the optional state of the specified field.
void	showError(String fieldName, String errorText) Marks a editor field as erroneous with optional error text.

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

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

Method Detail

getItemType

ComposedType getItemType()

Returns:

the item type assoziated with this editor.

getEditorFields

Set getEditorFields()

Returns:

all available editor field names within a case-insensitive set.

getCurrentValue

Object getCurrentValue(String fieldName)
                throws JaloInvalidParameterException

Parameters:

fieldName - (case-insensitive)

Returns:

the current editor value of the specified field

Throws:

JaloInvalidParameterException - if no field exists

setCurrentValue

void setCurrentValue(String fieldName,
                     Object value)
              throws JaloInvalidParameterException

Changes the current editor value of the specified field. The gui may render the field as modified.

Parameters:

fieldName - (case-insensitive)

value - the new value

Throws:

JaloInvalidParameterException - if no field exists

setInitialValue

void setInitialValue(String fieldName,
                     Object value)
              throws JaloInvalidParameterException

Changes the current editor value of the specified field. The gui render the field as not modified.

Parameters:

fieldName - (case-insensitive)

value - the new value

Throws:

JaloInvalidParameterException - if no field exists

Since:

3.0M2

setEditable

void setEditable(String fieldName,
                 boolean enabled)
          throws JaloInvalidParameterException

Changes the editable state of the specified field.

Parameters:

fieldName - the field name

enabled - if true the field will accept values, otherwise it is locked

Throws:

JaloInvalidParameterException - if no such field exists

isEditable

boolean isEditable(String fieldName)
            throws JaloInvalidParameterException

Returns the editable state of the specified field.

Parameters:

fieldName - (case-insensitive)

Throws:

JaloInvalidParameterException - if no such field exists

setOptional

void setOptional(String fieldName,
                 boolean optional)
          throws JaloInvalidParameterException

Changes the optional state of the specified field. If a field is marked as non-optional the hmc will raise an error on save if no value was entered.

Parameters:

fieldName - the field name

optional - if false the field requires a value

Throws:

JaloInvalidParameterException - if no such field exists

isOptional

boolean isOptional(String fieldName)
            throws JaloInvalidParameterException

Returns the optional state of the specified field.

Parameters:

fieldName - the field name

Throws:

JaloInvalidParameterException - if no such field exists

setDescription

void setDescription(String fieldName,
                    String descr)
             throws JaloInvalidParameterException

Changes the fields description. This text is shown as tooltip upon the field label.

Parameters:

fieldName - the field name

descr - the new description

Throws:

JaloInvalidParameterException - if no such field exists

getDescription

String getDescription(String fieldName)
               throws JaloInvalidParameterException

Returns the current description of this field.

Parameters:

fieldName - the field name

Throws:

JaloInvalidParameterException - if no such field exists

showError

void showError(String fieldName,
               String errorText)
        throws JaloInvalidParameterException

Marks a editor field as erroneous with optional error text. The gui will highlight the field and provide the error text.

Parameters:

fieldName -

errorText -

Throws:

JaloInvalidParameterException - if no field exists

clearError

void clearError(String fieldName)
         throws JaloInvalidParameterException

Resets the error state to 'normal'.

Parameters:

fieldName -

Throws:

JaloInvalidParameterException

clearAllErrors

void clearAllErrors()

Resets error states of all fields to 'normal'.

getCurrentTab

String getCurrentTab()

Returns:

the current name of the curretly active tab.

nextTab

void nextTab()

Jumps to the next tab. The tab order is defined by the layout described in hmc.tmpl .

Please note that WizardBusinessItem.tabChanges(WizardEditorContext, String, String) is triggered by this method too.

previousTab

void previousTab()

Jumps to the previous tab. The tab order is defined by the layout described in hmc.tmpl .

Please note that WizardBusinessItem.tabChanges(WizardEditorContext, String, String) is triggered by this method too.

setCurrentTab

void setCurrentTab(String tabName)
            throws JaloInvalidParameterException

Jumps to a specified tab.

Please note that WizardBusinessItem.tabChanges(WizardEditorContext, String, String) is triggered by this method too.

Throws:

JaloInvalidParameterException - if no such tab exists

postInfoMessage

void postInfoMessage(String msg)

Posts an info message which is displayed as popoup. If multiple messages are posted the may be shown separately or together within one single message window.

Parameters:

msg - the message to show

getPendingInfoMessages

List getPendingInfoMessages()

Returns all currently pending messages. Once the messages have been shown the queue is empty.

removeInfoMessage

void removeInfoMessage(int pos)
                throws JaloInvalidParameterException

Removes a single message from the current message queue. Please note that this will remove even messages from the hmc core components.

Parameters:

pos - the position of the message to remove from queue

Throws:

JaloInvalidParameterException - in case there is no message for the given position

clearAllInfoMessages

void clearAllInfoMessages()

Removes all info messages from the message queue. Please note that this will remove even messages from the hmc core components.

close

void close()

Since:

2.10