Package com.hybris.cockpitng.editor.localized

Class LocalizedEditor

java.lang.Object

com.hybris.cockpitng.editors.impl.AbstractCockpitEditorRenderer<java.lang.Object>

com.hybris.cockpitng.editor.localized.AbstractLocalizedEditor

com.hybris.cockpitng.editor.localized.LocalizedEditor

All Implemented Interfaces:

CockpitEditorRenderer<java.lang.Object>, WidgetInstanceManagerAware

public class LocalizedEditor
extends AbstractLocalizedEditor

Editor supports localized vales providing dedicated field for each localization.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.zkoss.zul.Label	defaultLocaleLabel
protected org.zkoss.zul.Div	dynamicContent
static java.lang.String	EDITOR_PARAM_ATTRIBUTE_DESCRIPTION
protected boolean	expanded
protected java.lang.String	expandedPropertyKey
protected org.zkoss.zul.Div	fixedContent
static java.lang.String	ID
protected org.zkoss.zul.Div	wrapperContainer
static java.lang.String	Y_ICON
static java.lang.String	YW_DYNAMIC_CONTENT
static java.lang.String	YW_LOCEDITOR_DISABLED

Fields inherited from class com.hybris.cockpitng.editor.localized.AbstractLocalizedEditor

LOCALIZED_EDITOR_LOCALE, SCLASS_CELL_LABEL, SCLASS_MANDATORY_ATTRIBUTE_LABEL, YW_LOCEDITOR_CAPTION

Fields inherited from class com.hybris.cockpitng.editors.impl.AbstractCockpitEditorRenderer

HEADER_LABEL_TOOLTIP, ON_ADD_EVENT, ON_DELETE_EVENT, YW_EDITOR_AREA_LABEL_CONTAINER

Fields inherited from interface com.hybris.cockpitng.editors.CockpitEditorRenderer

INITIAL_EDIT_STRING

Constructor Summary

Constructors

Constructor	Description
LocalizedEditor()

Method Summary

Modifier and Type	Method	Description
protected void	addOnClickActionToLocalizationButton(org.zkoss.zul.Span localizationButton, java.util.Map<java.util.Locale,Editor> editors, java.util.Map<java.util.Locale,java.lang.Object> value, EditorContext editorContext, EditorListener editorListener)
protected void	addValidationChangeListener(org.zkoss.zk.ui.Component parent, EditorContext editorContext)
protected void	applyRowsValidation(EditorContext editorContext)
protected void	applyValidationCss(org.zkoss.zul.Div wrapperCaption)
protected EditorListener<java.lang.Object>	decorateEditorListener(java.util.Locale locale, java.util.Map<java.util.Locale,java.lang.Object> values, EditorListener editorListener)
protected void	expand(java.util.Map<java.util.Locale,Editor> editors, java.util.Map<java.util.Locale,java.lang.Object> value, EditorContext editorContext, EditorListener editorListener)
protected void	expandImmediately(java.util.Map<java.util.Locale,Editor> editors, java.util.Map<java.util.Locale,java.lang.Object> value, EditorContext editorContext, EditorListener editorListener)
AttributeDescriptionIconRenderer	getAttributeDescriptionIconRenderer()
protected java.lang.String	getEditorParamAttributeDescription(EditorContext editorContext)
protected java.util.Map<java.util.Locale,java.lang.Object>	getNullSafeLocales(java.lang.Object initialValue)
protected java.util.Set<java.util.Locale>	getReadableLocales(EditorContext editorContext)
ValidationRenderer	getValidationRenderer()
protected java.util.Set<java.util.Locale>	getWriteableLocales(EditorContext editorContext)
protected java.util.Map<java.util.Locale,java.lang.Object>	initializeLocales(EditorContext editorContext)
protected boolean	isExpanded()
void	render(org.zkoss.zk.ui.Component parent, EditorContext editorContext, EditorListener editorListener)	Creates a new editor component and attaches it to the specified Component component.
protected void	renderLabels(org.zkoss.zul.Div content, org.zkoss.zul.Div row, org.zkoss.zul.Label label, java.util.Locale locale)
protected Editor	renderLocale(org.zkoss.zul.Div content, java.util.Locale locale, java.util.Map<java.util.Locale,java.lang.Object> value, EditorContext editorContext, EditorListener editorListener)
void	setAttributeDescriptionIconRenderer(AttributeDescriptionIconRenderer attributeDescriptionIconRenderer)
void	setValidationRenderer(ValidationRenderer validationRenderer)

Methods inherited from class com.hybris.cockpitng.editor.localized.AbstractLocalizedEditor

createEditorLabel, getActiveLocales, getCockpitLocaleService, getCockpitUserService, getComponentDefinitionService, getEditorRegistry, getLabelService, getWidgetInstanceManager, prepareSubEditor, prepareSubEditor, setCockpitLocaleService, setCockpitUserService, setComponentDefinitionService, setEditorRegistry, setLabelService, setWidgetInstanceManager

Methods inherited from class com.hybris.cockpitng.editors.impl.AbstractCockpitEditorRenderer

extractEmbeddedEditor, extractEmbeddedType, findAncestorEditor, findEmbeddedEditors, getInitialEditString, getL10nDecorator

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

EDITOR_PARAM_ATTRIBUTE_DESCRIPTION

public static final java.lang.String EDITOR_PARAM_ATTRIBUTE_DESCRIPTION

See Also:

Constant Field Values

YW_DYNAMIC_CONTENT

public static final java.lang.String YW_DYNAMIC_CONTENT

See Also:

Constant Field Values

Y_ICON

public static final java.lang.String Y_ICON

See Also:

Constant Field Values

YW_LOCEDITOR_DISABLED

public static final java.lang.String YW_LOCEDITOR_DISABLED

See Also:

Constant Field Values

expanded

protected boolean expanded

expandedPropertyKey

protected java.lang.String expandedPropertyKey

dynamicContent

protected org.zkoss.zul.Div dynamicContent

wrapperContainer

protected org.zkoss.zul.Div wrapperContainer

defaultLocaleLabel

protected org.zkoss.zul.Label defaultLocaleLabel

fixedContent

protected org.zkoss.zul.Div fixedContent

Constructor Detail

LocalizedEditor

public LocalizedEditor()

Method Detail

render

public void render(org.zkoss.zk.ui.Component parent,
                   EditorContext editorContext,
                   EditorListener editorListener)

Description copied from interface: CockpitEditorRenderer

Creates a new editor component and attaches it to the specified Component component.

Parameters:

parent - parent component the editor should be attached to

editorContext - the context for the editor creation

editorListener - the listener to notify the rest of the world about value changes and other events

renderLocale

protected Editor renderLocale(org.zkoss.zul.Div content,
                              java.util.Locale locale,
                              java.util.Map<java.util.Locale,java.lang.Object> value,
                              EditorContext editorContext,
                              EditorListener editorListener)

initializeLocales

protected java.util.Map<java.util.Locale,java.lang.Object> initializeLocales(EditorContext editorContext)

getNullSafeLocales

protected java.util.Map<java.util.Locale,java.lang.Object> getNullSafeLocales(java.lang.Object initialValue)

addOnClickActionToLocalizationButton

protected void addOnClickActionToLocalizationButton(org.zkoss.zul.Span localizationButton,
                                                    java.util.Map<java.util.Locale,Editor> editors,
                                                    java.util.Map<java.util.Locale,java.lang.Object> value,
                                                    EditorContext editorContext,
                                                    EditorListener editorListener)

addValidationChangeListener

protected void addValidationChangeListener(org.zkoss.zk.ui.Component parent,
                                           EditorContext editorContext)

expand

protected void expand(java.util.Map<java.util.Locale,Editor> editors,
                      java.util.Map<java.util.Locale,java.lang.Object> value,
                      EditorContext editorContext,
                      EditorListener editorListener)

expandImmediately

protected void expandImmediately(java.util.Map<java.util.Locale,Editor> editors,
                                 java.util.Map<java.util.Locale,java.lang.Object> value,
                                 EditorContext editorContext,
                                 EditorListener editorListener)

getReadableLocales

protected java.util.Set<java.util.Locale> getReadableLocales(EditorContext editorContext)

getWriteableLocales

protected java.util.Set<java.util.Locale> getWriteableLocales(EditorContext editorContext)

applyRowsValidation

protected void applyRowsValidation(EditorContext editorContext)

applyValidationCss

protected void applyValidationCss(org.zkoss.zul.Div wrapperCaption)

decorateEditorListener

protected EditorListener<java.lang.Object> decorateEditorListener(java.util.Locale locale,
                                                                  java.util.Map<java.util.Locale,java.lang.Object> values,
                                                                  EditorListener editorListener)

renderLabels

protected void renderLabels(org.zkoss.zul.Div content,
                            org.zkoss.zul.Div row,
                            org.zkoss.zul.Label label,
                            java.util.Locale locale)

getEditorParamAttributeDescription

protected java.lang.String getEditorParamAttributeDescription(EditorContext editorContext)

getValidationRenderer

public ValidationRenderer getValidationRenderer()

setValidationRenderer

public void setValidationRenderer(ValidationRenderer validationRenderer)

getAttributeDescriptionIconRenderer

public AttributeDescriptionIconRenderer getAttributeDescriptionIconRenderer()

setAttributeDescriptionIconRenderer

public void setAttributeDescriptionIconRenderer(AttributeDescriptionIconRenderer attributeDescriptionIconRenderer)

isExpanded

protected boolean isExpanded()