de.hybris.platform.hmc.generic

Class GenericItemChip.GenericItemEditorContext

java.lang.Object

de.hybris.platform.hmc.HMCHelper.DefaultHMCContext

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

All Implemented Interfaces:

HMCContext, ItemEditorContext, Serializable

Direct Known Subclasses:

GenericItemChip.GenericWizardEditorContext

Enclosing class:

GenericItemChip

protected class GenericItemChip.GenericItemEditorContext
extends HMCHelper.DefaultHMCContext
implements ItemEditorContext

The editor context implementation for non-wizard items. This class allows external usage of this editor without actually having a item chip reference or access to item chip methods.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenericItemEditorContext()

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()
protected AttributeChip	getAttributeChip(String fieldName)
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.
protected EditorTabChip	getTabChip(String tabName)
boolean	isEditable(String fieldName) Deprecated.
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) Deprecated.
void	setInitialValue(String fieldName, Object value) Changes the current editor value of the specified field.
void	setOptional(String fieldName, boolean optional) Not yet implemented !
void	showError(String fieldName, String errorText) Marks a editor field as erroneous with optional error text.

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.HMCContext

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

Constructor Detail

GenericItemEditorContext

protected GenericItemEditorContext()

Method Detail

getAttributeChip

protected AttributeChip getAttributeChip(String fieldName)
                                  throws JaloInvalidParameterException

Throws:

JaloInvalidParameterException

getTabChip

protected EditorTabChip getTabChip(String tabName)
                            throws JaloInvalidParameterException

Throws:

JaloInvalidParameterException

close

public void close()

Specified by:

close in interface ItemEditorContext

Since:

2.10

getItemType

public ComposedType getItemType()

Specified by:

getItemType in interface ItemEditorContext

Returns:

the item type assoziated with this editor.

getEditorFields

public Set getEditorFields()

Specified by:

getEditorFields in interface ItemEditorContext

Returns:

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

getCurrentValue

public Object getCurrentValue(String fieldName)
                       throws JaloInvalidParameterException

Specified by:

getCurrentValue in interface ItemEditorContext

Parameters:

fieldName - (case-insensitive)

Returns:

the current editor value of the specified field

Throws:

JaloInvalidParameterException - if no field exists

setCurrentValue

public void setCurrentValue(String fieldName,
                            Object value)
                     throws JaloInvalidParameterException

Description copied from interface: ItemEditorContext

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

Specified by:

setCurrentValue in interface ItemEditorContext

Parameters:

fieldName - (case-insensitive)

value - the new value

Throws:

JaloInvalidParameterException - if no field exists

setInitialValue

public void setInitialValue(String fieldName,
                            Object value)
                     throws JaloInvalidParameterException

Description copied from interface: ItemEditorContext

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

Specified by:

setInitialValue in interface ItemEditorContext

Parameters:

fieldName - (case-insensitive)

value - the new value

Throws:

JaloInvalidParameterException - if no field exists

Since:

3.0M2

getCurrentTab

public String getCurrentTab()

Specified by:

getCurrentTab in interface ItemEditorContext

Returns:

the current name of the curretly active tab.

nextTab

public void nextTab()

Description copied from interface: ItemEditorContext

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.

Specified by:

nextTab in interface ItemEditorContext

previousTab

public void previousTab()

Description copied from interface: ItemEditorContext

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.

Specified by:

previousTab in interface ItemEditorContext

setCurrentTab

public void setCurrentTab(String tabName)
                   throws JaloInvalidParameterException

Description copied from interface: ItemEditorContext

Jumps to a specified tab.

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

Specified by:

setCurrentTab in interface ItemEditorContext

Throws:

JaloInvalidParameterException - if no such tab exists

setEditable

@Deprecated
public void setEditable(String fieldName,
                                    boolean enabled)
                             throws JaloInvalidParameterException

Deprecated.

Description copied from interface: ItemEditorContext

Changes the editable state of the specified field.

Specified by:

setEditable in interface ItemEditorContext

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

@Deprecated
public boolean isEditable(String fieldName)
                               throws JaloInvalidParameterException

Deprecated.

Description copied from interface: ItemEditorContext

Returns the editable state of the specified field.

Specified by:

isEditable in interface ItemEditorContext

Parameters:

fieldName - (case-insensitive)

Throws:

JaloInvalidParameterException - if no such field exists

setOptional

public void setOptional(String fieldName,
                        boolean optional)
                 throws JaloInvalidParameterException

Not yet implemented !

Specified by:

setOptional in interface ItemEditorContext

Parameters:

fieldName - the field name

optional - if false the field requires a value

Throws:

JaloInvalidParameterException - if no such field exists

isOptional

public boolean isOptional(String fieldName)
                   throws JaloInvalidParameterException

Description copied from interface: ItemEditorContext

Returns the optional state of the specified field.

Specified by:

isOptional in interface ItemEditorContext

Parameters:

fieldName - the field name

Throws:

JaloInvalidParameterException - if no such field exists

setDescription

public void setDescription(String fieldName,
                           String descr)
                    throws JaloInvalidParameterException

Description copied from interface: ItemEditorContext

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

Specified by:

setDescription in interface ItemEditorContext

Parameters:

fieldName - the field name

descr - the new description

Throws:

JaloInvalidParameterException - if no such field exists

getDescription

public String getDescription(String fieldName)
                      throws JaloInvalidParameterException

Description copied from interface: ItemEditorContext

Returns the current description of this field.

Specified by:

getDescription in interface ItemEditorContext

Parameters:

fieldName - the field name

Throws:

JaloInvalidParameterException - if no such field exists

showError

public void showError(String fieldName,
                      String errorText)
               throws JaloInvalidParameterException

Description copied from interface: ItemEditorContext

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

Specified by:

showError in interface ItemEditorContext

Throws:

JaloInvalidParameterException - if no field exists

clearError

public void clearError(String fieldName)
                throws JaloInvalidParameterException

Description copied from interface: ItemEditorContext

Resets the error state to 'normal'.

Specified by:

clearError in interface ItemEditorContext

Throws:

JaloInvalidParameterException

clearAllErrors

public void clearAllErrors()

Description copied from interface: ItemEditorContext

Resets error states of all fields to 'normal'.

Specified by:

clearAllErrors in interface ItemEditorContext

postInfoMessage

public void postInfoMessage(String msg)

Description copied from interface: ItemEditorContext

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.

Specified by:

postInfoMessage in interface ItemEditorContext

Parameters:

msg - the message to show

getPendingInfoMessages

public List getPendingInfoMessages()

Description copied from interface: ItemEditorContext

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

Specified by:

getPendingInfoMessages in interface ItemEditorContext

removeInfoMessage

public void removeInfoMessage(int pos)
                       throws JaloInvalidParameterException

Description copied from interface: ItemEditorContext

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

Specified by:

removeInfoMessage in interface ItemEditorContext

Parameters:

pos - the position of the message to remove from queue

Throws:

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

clearAllInfoMessages

public void clearAllInfoMessages()

Description copied from interface: ItemEditorContext

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

Specified by:

clearAllInfoMessages in interface ItemEditorContext