de.hybris.platform.hmc.attribute

Class LocalizableAttributeChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.attribute.AttributeChip

de.hybris.platform.hmc.attribute.LocalizableAttributeChip

All Implemented Interfaces:

AjaxRequestHandler, ComposedChip, Chip, Serializable, Cloneable, Comparable

Direct Known Subclasses:

LocalizableAttributeSelectChip

public class LocalizableAttributeChip
extends AttributeChip
implements ComposedChip, AjaxRequestHandler

This is a display chip for editing localizable attributes of an item. It provides a simple view for editing the value in the current session language and an enhanced view for value editing in all languages. Switching between these two views will be done via a flag symbol button. The editors which should be used for the single values can be set via setEditors(Map) or can be generated by this class if the editor type is given in the constructor.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLLAPSE_LOCALIZE Command string for collapsing the input fields, so that only the field for the default language is displayed.
static String	EXPAND_LOCALIZE Command string for expanding the input fields for localized input.
static String	TOGGLE

Fields inherited from class de.hybris.platform.hmc.attribute.AttributeChip

EMPTY_ATTRIBUTE_NAME, KEEP_ALIVE, SET_SELECTED

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
LocalizableAttributeChip(DisplayState displayState, Chip parent, String attributeName, Type attributeValueType)
LocalizableAttributeChip(DisplayState displayState, Chip parent, String attributeName, Type attributeValueType, String editorType, Class customEditorClass)
LocalizableAttributeChip(DisplayState displayState, Chip parent, String attributeName, Type attributeValueType, String editorType, Class customEditorClass, Map initialValues)

Method Summary

Modifier and Type	Method and Description
void	checkValid() Checks if all language references and all value editors still valid.
void	clearError()
List<AbstractAttributeEditorChip>	getChildren()
Language	getCurrentLanguage()
AbstractAttributeEditorChip	getEditor()
AbstractAttributeEditorChip	getEditor(Language language) Returns the editor for the given session language.
Map<Language,AbstractAttributeEditorChip>	getEditors()
protected Map<Language,AbstractAttributeEditorChip>	getEditorsInternal()
Object	getInitialValue()
Map<Language,Object>	getInitialValues() Returns a Map containing the initial localized values of this attribute.
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
Language	getLanguage(AbstractAttributeEditorChip editor) Some editors need to know which language they are using.
Set<Language>	getReadableLanguages()
Object	getValue()
Map<Language,Object>	getValues() Returns a Map containing the localized values of this attribute.
Set<Language>	getWritableLanguages()
protected void	initializeEditor()
boolean	isAjaxUpdatable() Returns true if the contained editor chips are all "AjaxUpdatable".
boolean	isChanged() Returns true if the value of this chip's editor has changed, i.e.
boolean	isExpandable()
boolean	isExpanded()
void	processAjaxEvents(HttpServletRequest request, HttpServletResponse response, PrintWriter out, Map requestParameters)
void	processEvents(Map events) Handles all incoming requests for this chip.
void	refreshEditors()
void	saveAttribute(AbstractAttributeEditorChip editorChip)
void	setEditable(boolean editable)
void	setEditor(AbstractAttributeEditorChip editor) throws exception!
protected void	setEditors(Map<Language,AbstractAttributeEditorChip> newEditors)
protected void	setExpanded(boolean expanded)
void	setInitialValue(Object value)
void	setInitialValues(Map<Language,Object> values)
void	setMaxLength(int maxLength)
void	setValue(Object value)
void	setValues(Map values)

Methods inherited from class de.hybris.platform.hmc.attribute.AttributeChip

compareTo, createEditor, createEditor, createEditor, getAttributeDescriptor, getAttributeQualifier, getAttributeType, getDefaultEditorType, getDefaultEditorType, getDescription, getDescriptionAttribute, getDescriptionAttributeValue, getEditorClass, getEditorType, getError, getErrorText, getItem, getLabel, getLabelWidth, getProposedUniqueName, getToolTip, hasError, hasErrorText, isEditable, isEncrypted, isHideLabel, isOptional, isPartOf, isRequired, isSelected, setDescription, setDescriptionAttribute, setEditorClass, setEditorType, setEncrypted, setError, setErrorText, setHideLabel, setLabelWidth, setSelected

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, 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

Methods inherited from interface de.hybris.platform.hmc.webchips.Chip

addEventListener, dispose, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getID, getJaloSession, getMenuEntries, getParent, getUniqueName, goFullScreen, isValid, leaveFullScreen, registerUniqueName, removeEventListener, render, translateFormFieldToEventName, translateFormFieldToEventValue

Field Detail

EXPAND_LOCALIZE

public static final String EXPAND_LOCALIZE

Command string for expanding the input fields for localized input.

See Also:

Constant Field Values

COLLAPSE_LOCALIZE

public static final String COLLAPSE_LOCALIZE

Command string for collapsing the input fields, so that only the field for the default language is displayed.

See Also:

Constant Field Values

TOGGLE

public static final String TOGGLE

See Also:

Constant Field Values

Constructor Detail

LocalizableAttributeChip

public LocalizableAttributeChip(DisplayState displayState,
                                Chip parent,
                                String attributeName,
                                Type attributeValueType,
                                String editorType,
                                Class customEditorClass,
                                Map initialValues)

LocalizableAttributeChip

public LocalizableAttributeChip(DisplayState displayState,
                                Chip parent,
                                String attributeName,
                                Type attributeValueType,
                                String editorType,
                                Class customEditorClass)

LocalizableAttributeChip

public LocalizableAttributeChip(DisplayState displayState,
                                Chip parent,
                                String attributeName,
                                Type attributeValueType)

Method Detail

initializeEditor

protected void initializeEditor()

Overrides:

initializeEditor in class AttributeChip

setEditor

public void setEditor(AbstractAttributeEditorChip editor)

throws exception!

Overrides:

setEditor in class AttributeChip

getEditor

public AbstractAttributeEditorChip getEditor()

Overrides:

getEditor in class AttributeChip

Returns:

The editor for the current language.

getEditor

public AbstractAttributeEditorChip getEditor(Language language)

Returns the editor for the given session language.

Parameters:

language - the Language for which to return the appropriate editor

Returns:

The editor for the given session language.

Since:

1.31

setEditors

protected void setEditors(Map<Language,AbstractAttributeEditorChip> newEditors)

Parameters:

newEditors - Map of Language to AbstractAttributeEditorChip.

getEditorsInternal

protected Map<Language,AbstractAttributeEditorChip> getEditorsInternal()

Returns:

Map of Language to AbstractAttributeEditorChip.

getEditors

public Map<Language,AbstractAttributeEditorChip> getEditors()

Returns:

Unmodifieable map of Language to AbstractAttributeEditorChip.

setInitialValues

public void setInitialValues(Map<Language,Object> values)

setInitialValue

public void setInitialValue(Object value)

Overrides:

setInitialValue in class AttributeChip

setExpanded

protected void setExpanded(boolean expanded)

Parameters:

expanded - If the editor is in the enhanced view mode (TRUE) displaying the values in all languages or in simple mode (FALSE).

isExpanded

public boolean isExpanded()

Returns:

If the editor is in the enhanced view mode (TRUE) displaying the values in all languages or in simple mode (FALSE).

isExpandable

public boolean isExpandable()

getCurrentLanguage

public Language getCurrentLanguage()

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)

Specified by:

processEvents in interface Chip

Overrides:

processEvents in class AttributeChip

getValues

public Map<Language,Object> getValues()

Returns a Map containing the localized values of this attribute. Maps Language to value ( Object).

Returns:

a Map containing the localized values of this attribute. Maps Language to value ( Object ).

getValue

public Object getValue()

Overrides:

getValue in class AttributeChip

Returns:

The value of the AbstractAttributeEditorChip.

getInitialValues

public Map<Language,Object> getInitialValues()

Returns a Map containing the initial localized values of this attribute. Maps Language to value ( Object).

Returns:

a Map containing the initial localized values of this attribute. Maps Language to value ( Object).

getInitialValue

public Object getInitialValue()

Overrides:

getInitialValue in class AttributeChip

Returns:

The inital value of the AbstractAttributeEditorChip.

setValues

public void setValues(Map values)

setValue

public void setValue(Object value)

Overrides:

setValue in class AttributeChip

getJSPURI

public String getJSPURI()

Description copied from interface: Chip

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

Specified by:

getJSPURI in interface Chip

Overrides:

getJSPURI in class AttributeChip

refreshEditors

public void refreshEditors()

checkValid

public void checkValid()

Checks if all language references and all value editors still valid.

Specified by:

checkValid in interface Chip

Overrides:

checkValid in class AttributeChip

getLanguage

public Language getLanguage(AbstractAttributeEditorChip editor)

Some editors need to know which language they are using. This method tells them.

getChildren

public List<AbstractAttributeEditorChip> getChildren()

Specified by:

getChildren in interface ComposedChip

isChanged

public boolean isChanged()

Description copied from class: AttributeChip

Returns true if the value of this chip's editor has changed, i.e. if the editor's AbstractAttributeEditorChip.isChanged() method returns true.

Overrides:

isChanged in class AttributeChip

Returns:

true if the value of this chip's editor has changed, i.e. if the editor's AbstractAttributeEditorChip.isChanged() method returns true.

Since:

2.00

getReadableLanguages

public Set<Language> getReadableLanguages()

Returns:

Returns the readableLanguages.

getWritableLanguages

public Set<Language> getWritableLanguages()

Returns:

Returns the writableLanguages.

setEditable

public void setEditable(boolean editable)

Overrides:

setEditable in class AttributeChip

setMaxLength

public void setMaxLength(int maxLength)

Overrides:

setMaxLength in class AttributeChip

Since:

3.00 (beta1)

clearError

public void clearError()

Overrides:

clearError in class AttributeChip

Since:

3.00 (beta1)

saveAttribute

public void saveAttribute(AbstractAttributeEditorChip editorChip)

Overrides:

saveAttribute in class AttributeChip

Since:

3.0 M2

processAjaxEvents

public void processAjaxEvents(HttpServletRequest request,
                              HttpServletResponse response,
                              PrintWriter out,
                              Map requestParameters)

Specified by:

processAjaxEvents in interface AjaxRequestHandler

Since:

3.0 (beta1)

isAjaxUpdatable

public boolean isAjaxUpdatable()

Returns true if the contained editor chips are all "AjaxUpdatable". The jsp may then provide an ajax-driven localization toggle button which only reloads the editor(s) rather than the whole page.

Since:

3.0 M3