com.hybris.cockpitng.common

Class EditorConfigurator

java.lang.Object

com.hybris.cockpitng.common.EditorConfigurator

public class EditorConfigurator
extends Object

Constructor Summary

Constructors

Constructor and Description
EditorConfigurator(Editor editor) Creates a configurator - object that helps configuring existing Editor components.

Method Summary

Modifier and Type	Method and Description
void	addParameter(String parameter, Object value) Adds a parameter to editor's context.
<VALUE> void	addParameters(Map<String,VALUE> parameters) Adds parameters to editor's context.
void	configure(DataAttribute attribute) Configures editor in the way that it may be used to manipulate with values of specified attribute and sets all default configuration that it causes
void	configure(DataType dataType) Sets default configuration of editor for specified data type
void	configure(Object item, DataAttribute attribute) Configures editor in the way that it may be used to manipulate with values of specified attribute and sets all default configuration that it causes
void	configure(String widgetModelKey, DataAttribute attribute) Configures editor in the way that it may be used to manipulate with values of specified attribute.
protected <E extends org.zkoss.zk.ui.event.Event> org.zkoss.zk.ui.event.EventListener<E>	createReferenceUpdateListener(DataAttribute attribute)
void	enableValidation(String modelKey, String qualifier, ValidatableContainer container) Configures validation for editor.
protected String	getAttributeDescription(String dataType, String qualifier)
protected String	getAttributeLabel(String dataType, String qualifier)
protected ObjectValuePath	getEditorPathPrefix(ObjectValuePath editorProperty, String attributeQualifier)
protected EditorRegistry	getEditorRegistry()
protected LabelService	getLabelService()
protected ObjectFacade	getObjectFacade()
protected PermissionFacade	getPermissionFacade()
ReferenceModelProperties	getReferenceModelProperties()
TypeFacade	getTypeFacade()
protected boolean	isReferenceEditor(DataAttribute genericAttribute)
protected Map<Pattern,String>	prepareSinglingEditorMappings()
void	setAttached(DataAttribute attribute) Configures editor in the way that it may be used to manipulate with values of specified attribute.
void	setAttached(Object item, DataAttribute attribute) Configures editor in the way that it may be used to manipulate with values of specified attribute.
void	setAttached(Object item, String qualifier) Configures editor in the way that it may be used to manipulate with values of specified attribute.
void	setAttached(String qualifier) Configures editor in the way that it may be used to manipulate with values of specified attribute.
void	setAttached(String widgetModelKey, String qualifier) Configures editor in the way that it may be used to manipulate with values of specified attribute.
protected void	setDefaults(DataAttribute attribute)
protected void	setDefaults(DataType dataType)
void	setDescription(String description) Some editors are capable of decorating editor component with proper description (i.e.
void	setEditorRegistry(EditorRegistry editorRegistry)
void	setLabel(String label) Some editors are capable of decorating editor component with proper label (i.e.
void	setLabelService(LabelService labelService)
void	setMultilingual(boolean multilingual) Configures editor so that it allows to input values different languages.
void	setMultilingual(boolean multilingual, Object item) Configures editor so that it allows to input values different languages.
void	setMultilingual(boolean multilingual, Set<Locale> locales) Configures editor so that it allows to input values different languages.
void	setObjectFacade(ObjectFacade objectFacade)
void	setPermissionFacade(PermissionFacade permissionFacade)
void	setReferenceModelProperties(ReferenceModelProperties referenceModelProperties)
void	setSingleValued() Changes all multivalued editors into single-valued - i.e.
void	setTypeFacade(TypeFacade typeFacade)
protected void	updateObjectsReferencedByEditor(DataAttribute attribute)
void	useDefaultEditor() Resets editor, so that is uses the default one for previously configured data type

Methods inherited from class java.lang.Object

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

Constructor Detail

EditorConfigurator

public EditorConfigurator(Editor editor)

Creates a configurator - object that helps configuring existing Editor components.

All needed facades will be taken from spring bean context as default.

Parameters:

editor - component to be configured

Method Detail

getPermissionFacade

protected PermissionFacade getPermissionFacade()

setPermissionFacade

public void setPermissionFacade(PermissionFacade permissionFacade)

getEditorRegistry

protected EditorRegistry getEditorRegistry()

setEditorRegistry

public void setEditorRegistry(EditorRegistry editorRegistry)

getObjectFacade

protected ObjectFacade getObjectFacade()

setObjectFacade

public void setObjectFacade(ObjectFacade objectFacade)

getLabelService

protected LabelService getLabelService()

setLabelService

public void setLabelService(LabelService labelService)

getTypeFacade

public TypeFacade getTypeFacade()

setTypeFacade

public void setTypeFacade(TypeFacade typeFacade)

getReferenceModelProperties

public ReferenceModelProperties getReferenceModelProperties()

setReferenceModelProperties

public void setReferenceModelProperties(ReferenceModelProperties referenceModelProperties)

addParameters

public <VALUE> void addParameters(Map<String,VALUE> parameters)

Adds parameters to editor's context.

Parameters:

parameters - parameters to be added

addParameter

public void addParameter(String parameter,
                         Object value)

Adds a parameter to editor's context.

Parameters:

parameter - parameter name

value - parameter

setSingleValued

public void setSingleValued()

Changes all multivalued editors into single-valued - i.e. localized editors should allow providing values only for a single language, multi-reference editors should allow providing only single reference, etc.

prepareSinglingEditorMappings

protected Map<Pattern,String> prepareSinglingEditorMappings()

setAttached

public void setAttached(DataAttribute attribute)

Configures editor in the way that it may be used to manipulate with values of specified attribute.

Parameters:

attribute - attribute which values will be changed by editor

See Also:

setDefaults(DataAttribute)

isReferenceEditor

protected boolean isReferenceEditor(DataAttribute genericAttribute)

createReferenceUpdateListener

protected <E extends org.zkoss.zk.ui.event.Event> org.zkoss.zk.ui.event.EventListener<E> createReferenceUpdateListener(DataAttribute attribute)

updateObjectsReferencedByEditor

protected void updateObjectsReferencedByEditor(DataAttribute attribute)

getEditorPathPrefix

protected ObjectValuePath getEditorPathPrefix(ObjectValuePath editorProperty,
                                              String attributeQualifier)

getAttributeLabel

protected String getAttributeLabel(String dataType,
                                   String qualifier)

getAttributeDescription

protected String getAttributeDescription(String dataType,
                                         String qualifier)

setAttached

public void setAttached(Object item,
                        DataAttribute attribute)

Configures editor in the way that it may be used to manipulate with values of specified attribute.

Parameters:

item - item model which attribute will be changed by editor

attribute - attribute which values will be changed by editor

See Also:

configure(Object, DataAttribute)

setAttached

public void setAttached(Object item,
                        String qualifier)

Configures editor in the way that it may be used to manipulate with values of specified attribute.

Parameters:

item - item model which attribute will be changed by editor

qualifier - qualifier of attribute which values will be changed by editor

setAttached

public void setAttached(String widgetModelKey,
                        String qualifier)

Configures editor in the way that it may be used to manipulate with values of specified attribute.

Parameters:

widgetModelKey - name of widget model value under which an item may be found, which attribute will be changed by editor

qualifier - qualifier of attribute which values will be changed by editor

See Also:

configure(String, DataAttribute)

setAttached

public void setAttached(String qualifier)

Configures editor in the way that it may be used to manipulate with values of specified attribute.

Parameters:

qualifier - qualifier of attribute which values will be changed by editor

See Also:

configure(String, DataAttribute)

setDefaults

protected void setDefaults(DataType dataType)

setDefaults

protected void setDefaults(DataAttribute attribute)

configure

public void configure(DataType dataType)

Sets default configuration of editor for specified data type

Parameters:

dataType - type of data that is to be edited

configure

public void configure(DataAttribute attribute)

Configures editor in the way that it may be used to manipulate with values of specified attribute and sets all default configuration that it causes

Parameters:

attribute - attribute which values will be changed by editor

See Also:

setAttached(DataAttribute)

configure

public void configure(Object item,
                      DataAttribute attribute)

Configures editor in the way that it may be used to manipulate with values of specified attribute and sets all default configuration that it causes

Parameters:

item - item model which attribute will be changed by editor

attribute - attribute which values will be changed by editor

See Also:

setAttached(Object, DataAttribute)

configure

public void configure(String widgetModelKey,
                      DataAttribute attribute)

Configures editor in the way that it may be used to manipulate with values of specified attribute.

Parameters:

widgetModelKey - name of widget model value under which an item may be found, which attribute will be changed by editor

attribute - attribute which values will be changed by editor

See Also:

setAttached(String, String)

setLabel

public void setLabel(String label)

Some editors are capable of decorating editor component with proper label (i.e. localized editors). Please provide proper label to make it possible.

Parameters:

label - label to be used

setDescription

public void setDescription(String description)

Some editors are capable of decorating editor component with proper description (i.e. localized editors). Please provide proper text to make it possible.

Parameters:

description - description to be used

setMultilingual

public void setMultilingual(boolean multilingual)

Configures editor so that it allows to input values different languages.

Parameters:

multilingual - true if editor should allow providing values for different languages

See Also:

setSingleValued()

setMultilingual

public void setMultilingual(boolean multilingual,
                            Object item)

Configures editor so that it allows to input values different languages.

Parameters:

multilingual - true if editor should allow providing values for different languages

item - an item which values will be provided/displayed by editor

See Also:

PermissionFacade.getReadableLocalesForInstance(Object), PermissionFacade.getWritableLocalesForInstance(Object)

setMultilingual

public void setMultilingual(boolean multilingual,
                            Set<Locale> locales)

Configures editor so that it allows to input values different languages.

Parameters:

multilingual - true if editor should allow providing values for different languages

locales - collection of locales for which value may be provided

useDefaultEditor

public void useDefaultEditor()

Resets editor, so that is uses the default one for previously configured data type

See Also:

Editor.setType(String)

enableValidation

public void enableValidation(String modelKey,
                             String qualifier,
                             ValidatableContainer container)

Configures validation for editor.

Parameters:

modelKey - name of widget model value under which an item may be found, which attribute will be changed by editor

qualifier - qualifier of attribute which values will be changed by editor

container - validatable container