com.hybris.cockpitng.common

Class EditorBuilder

java.lang.Object

com.hybris.cockpitng.common.EditorBuilder

public class EditorBuilder
extends Object

Builder class to help creating and configuring Editor components

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	EditorBuilder.AbstractConditional<ELEMENT>
static interface	EditorBuilder.Conditional<ELEMENT> Defines builder configuration depending on condition
protected class	EditorBuilder.EditorBuilderConditional
protected class	EditorBuilder.EditorConditional

Constructor Summary

Constructors

Constructor and Description
EditorBuilder(EditorContext<?> editorContext) Creates new builder basing on provided editor's context.
EditorBuilder(WidgetInstanceManager widgetInstanceManager) Creates new builder for Editor that will work with provided widget.
EditorBuilder(WidgetInstanceManager widgetInstanceManager, DataAttribute genericAttribute, String referencedModelProperty) Deprecated. since 6.7, use instead: configure(DataAttribute),set configure(String, DataAttribute)

Method Summary

Modifier and Type	Method and Description
EditorBuilder	addParameter(String parameter, Object value) Adds a parameter to editor's context.
<V> EditorBuilder	addParameters(Map<String,V> parameters) Adds parameters to editor's context.
<ELEMENT> EditorBuilder	addParameters(Stream<ELEMENT> stream, Function<ELEMENT,String> keySupplier, Function<ELEMENT,Object> valueSupplier) Adds a parameter to editor's context.
EditorBuilder	appendSClass(String sclass) Adds a CSS class to editor component.
EditorBuilder	apply(Consumer<Editor> configuration) Allows any modification of editor to be applied before it is initialized.
EditorBuilder	attach(String qualifier) Configures editor in the way that it may be used to manipulate with values of specified attribute.
Editor	build() Builds editor component
Editor	buildNotInitialized() Deprecated. since 6.7, please create an instance manually and use EditorConfigurator instead
EditorBuilder	configure(DataAttribute attribute) Configures component to use default behavior for specified attribute
EditorBuilder	configure(DataType dataType) Configures component to use default behavior for specified type.
EditorBuilder	configure(String itemKey, DataAttribute attribute) Configures component to use default behavior for specified attribute of item
EditorBuilder	configure(String itemKey, String qualifier) Configures component to use default behavior for specified attribute of item
EditorBuilder	enableValidation(String modelKey, String qualifier, ValidatableContainer container) Configures validation for editor.
protected ObjectFacade	getObjectFacade()
protected PermissionFacade	getPermissionFacade()
protected TypeFacade	getTypeFacade()
WidgetInstanceManager	getWidgetInstanceManager()
EditorBuilder.Conditional<Editor>	ifTrue(boolean test) Allows conditional modification of editor before it is initialized using flow programming.
EditorBuilder	setDescription(String description) Some editors are capable of decorating editor component with proper description (i.e.
EditorBuilder	setEditor(String editorType) Deprecated. since 6.7, use #useEditor(String) instead
EditorBuilder	setEditorRegistry(EditorRegistry editorRegistry)
EditorBuilder	setEditorType(String editorType) Deprecated. since 6.7, use useEditor(String) instead
EditorBuilder	setLabel(String label) Some editors are capable of decorating editor component with proper label (i.e.
EditorBuilder	setLabelService(LabelService labelService)
EditorBuilder	setMultilingual(boolean multilingual) Configures editor in context of allowing providing localized values in regards to specified flag.
EditorBuilder	setMultilingual(boolean multilingual, Object item) Configures editor in context of allowing providing localized values in regards to specified flag.
EditorBuilder	setObjectFacade(ObjectFacade objectFacade)
EditorBuilder	setOptional(boolean optional) Informs whether editor value should be mandatory.
EditorBuilder	setPermissionFacade(PermissionFacade permissionFacade)
EditorBuilder	setReadOnly(boolean readOnly) Informs whether editor value should work in read-only mode.
EditorBuilder	setReferenceModelProperties(ReferenceModelProperties referenceModelProperties)
EditorBuilder	setSingleValued() Changes all multivalued editors into single-valued - i.e.
EditorBuilder	setTypeFacade(TypeFacade typeFacade)
EditorBuilder	setValue(Object value) Initializes editor component with provided value.
EditorBuilder	setValueCreationEnabled(boolean enabled) Some editors allows creation new values (i.e.
EditorBuilder	setValueType(String valueType) Sets an encoded type of value that editor is supposed to provide (i.e.
EditorBuilder	useDefaultEditor() Updates editor definition to be used basing on value type
EditorBuilder	useEditor(String editorType) Explicitly defines which editor definition should be used by component
EditorBuilder.Conditional<EditorBuilder>	when(boolean test) Allows conditional builder configuration using flow programming.

Methods inherited from class java.lang.Object

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

Constructor Detail

EditorBuilder

public EditorBuilder(WidgetInstanceManager widgetInstanceManager)

Creates new builder for Editor that will work with provided widget.

Specific implementations of facades may be provided.

Parameters:

widgetInstanceManager - editor manager of widget with which editor is supposed to work

EditorBuilder

public EditorBuilder(EditorContext<?> editorContext)

Creates new builder basing on provided editor's context.

Parameters:

editorContext - base editor context

EditorBuilder

@Deprecated
public EditorBuilder(WidgetInstanceManager widgetInstanceManager,
                                 DataAttribute genericAttribute,
                                 String referencedModelProperty)

Deprecated. since 6.7, use instead: configure(DataAttribute),set configure(String, DataAttribute)

Method Detail

getTypeFacade

protected TypeFacade getTypeFacade()

setTypeFacade

public EditorBuilder setTypeFacade(TypeFacade typeFacade)

getPermissionFacade

protected PermissionFacade getPermissionFacade()

setPermissionFacade

public EditorBuilder setPermissionFacade(PermissionFacade permissionFacade)

getObjectFacade

protected ObjectFacade getObjectFacade()

setObjectFacade

public EditorBuilder setObjectFacade(ObjectFacade objectFacade)

setReferenceModelProperties

public EditorBuilder setReferenceModelProperties(ReferenceModelProperties referenceModelProperties)

setEditorRegistry

public EditorBuilder setEditorRegistry(EditorRegistry editorRegistry)

setLabelService

public EditorBuilder setLabelService(LabelService labelService)

getWidgetInstanceManager

public WidgetInstanceManager getWidgetInstanceManager()

Returns:

editor manager of widget with which editor is supposed to work

build

public Editor build()

Builds editor component

Returns:

initialized and ready for use Editor

buildNotInitialized

@Deprecated
public Editor buildNotInitialized()

Deprecated. since 6.7, please create an instance manually and use EditorConfigurator instead

Builds editor component without initializing it. Initialization (Editor.initialize() should be performed before using Editor.

Returns:

configured but not initialized Editor

See Also:

EditorConfigurator

apply

public EditorBuilder apply(Consumer<Editor> configuration)

Allows any modification of editor to be applied before it is initialized.

Parameters:

configuration - a function configuring editor

Returns:

builder for further settings

ifTrue

public EditorBuilder.Conditional<Editor> ifTrue(boolean test)

Allows conditional modification of editor before it is initialized using flow programming.

Parameters:

test - condition to be met for modification to be applied

Returns:

an object that defines modification depending on condition

when

public EditorBuilder.Conditional<EditorBuilder> when(boolean test)

Allows conditional builder configuration using flow programming.

Parameters:

test - condition to be met for configuration to be applied

Returns:

an object that defines configuration depending on condition

configure

public EditorBuilder configure(DataAttribute attribute)

Configures component to use default behavior for specified attribute

Parameters:

attribute - attribute to be manipulated by editor

Returns:

builder for further settings

See Also:

configure(String, String), configure(String, DataAttribute)

configure

public EditorBuilder configure(String itemKey,
                               DataAttribute attribute)

Configures component to use default behavior for specified attribute of item

Parameters:

itemKey - model value key under which a manipulated item may be found

attribute - attribute to be manipulated by editor

Returns:

builder for further settings

See Also:

configure(String, String)

configure

public EditorBuilder configure(String itemKey,
                               String qualifier)

Configures component to use default behavior for specified attribute of item

Parameters:

itemKey - model value key under which a manipulated item may be found

qualifier - qualifier of attribute to be manipulated by editor

Returns:

builder for further settings

See Also:

configure(String, DataAttribute)

configure

public EditorBuilder configure(DataType dataType)

Configures component to use default behavior for specified type.

Method should be used, if editor is not supposed to manipulate with any item, rather to provide a value of specified type.

Parameters:

dataType - type of value to be provided by editor

Returns:

builder for further settings

See Also:

configure(String, DataAttribute), configure(String, String)

attach

public EditorBuilder attach(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

Returns:

builder for further settings

addParameter

public EditorBuilder addParameter(String parameter,
                                  Object value)

Adds a parameter to editor's context.

Parameters:

parameter - parameter's name

value - parameters's value

Returns:

builder for further settings

addParameters

public <V> EditorBuilder addParameters(Map<String,V> parameters)

Adds parameters to editor's context.

Parameters:

parameters - parameters to be added

Returns:

builder for further settings

addParameters

public <ELEMENT> EditorBuilder addParameters(Stream<ELEMENT> stream,
                                             Function<ELEMENT,String> keySupplier,
                                             Function<ELEMENT,Object> valueSupplier)

Adds a parameter to editor's context.

Parameters:

stream - stream of parameters definitions

keySupplier - a supplier to provide parameter name out of definition

valueSupplier - a supplier to provide parameter value out of definition

Returns:

builder for further settings

setSingleValued

public EditorBuilder 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.

Returns:

builder to continue configuration of editor

setReadOnly

public EditorBuilder setReadOnly(boolean readOnly)

Informs whether editor value should work in read-only mode.

Parameters:

readOnly - true if value should work in read-only mode.

Returns:

builder to continue configuration of editor

setMultilingual

public EditorBuilder setMultilingual(boolean multilingual)

Configures editor in context of allowing providing localized values in regards to specified flag.

Parameters:

multilingual - true if editor should allow localized values, false otherwise

Returns:

builder to continue configuration of editor

See Also:

setMultilingual(boolean, Object)

setMultilingual

public EditorBuilder setMultilingual(boolean multilingual,
                                     Object item)

Configures editor in context of allowing providing localized values in regards to specified flag.

Parameters:

item - item which attribute will be manipulated with editor

multilingual - true if editor should allow localized values, false otherwise

Returns:

builder to continue configuration of editor

setOptional

public EditorBuilder setOptional(boolean optional)

Informs whether editor value should be mandatory.

Parameters:

optional - true if value should not be mandatory

Returns:

builder to continue configuration of editor

setValue

public EditorBuilder setValue(Object value)

Initializes editor component with provided value.

Parameters:

value - value to be displayed initially

Returns:

builder to continue configuration of editor

setValueType

public EditorBuilder setValueType(String valueType)

Sets an encoded type of value that editor is supposed to provide (i.e. LIST(Product))

Editor type is not updated in this method!

Parameters:

valueType - encoded value type

Returns:

builder to continue configuration of editor

See Also:

useEditor(String)

setEditorType

@Deprecated
public EditorBuilder setEditorType(String editorType)

Deprecated. since 6.7, use useEditor(String) instead

useEditor

public EditorBuilder useEditor(String editorType)

Explicitly defines which editor definition should be used by component

Parameters:

editorType - editor definition id

Returns:

builder to continue configuration of editor

See Also:

setValueType(String)

useDefaultEditor

public EditorBuilder useDefaultEditor()

Updates editor definition to be used basing on value type

Returns:

builder to continue configuration of editor

See Also:

setValueType(String)

setEditor

@Deprecated
public EditorBuilder setEditor(String editorType)

Deprecated. since 6.7, use #useEditor(String) instead

Configures which editor should be used - either specified or default one.

Parameters:

editorType - editor to be used or null for default

Returns:

builder to continue configuration of editor

setValueCreationEnabled

public EditorBuilder setValueCreationEnabled(boolean enabled)

Some editors allows creation new values (i.e. new items to be referenced). This method allows setting whether such possibility should be available.

Parameters:

enabled - true if value creation should be possible

Returns:

builder to continue configuration of editor

appendSClass

public EditorBuilder appendSClass(String sclass)

Adds a CSS class to editor component.

Parameters:

sclass - name of CSS class to be added

Returns:

builder to continue configuration of editor

setLabel

public EditorBuilder 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

Returns:

builder to continue configuration of editor

setDescription

public EditorBuilder 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

Returns:

builder to continue configuration of editor

enableValidation

public EditorBuilder 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

Returns:

builder to continue configuration of editor