Package com.hybris.cockpitng.editor.defaultmultireferenceeditor

Class DefaultMultiReferenceEditor<T>

java.lang.Object

com.hybris.cockpitng.engine.impl.AbstractComponentWidgetAdapterAware

com.hybris.cockpitng.editor.commonreferenceeditor.AbstractReferenceEditor<T,java.util.Collection<T>>

com.hybris.cockpitng.editor.defaultmultireferenceeditor.DefaultMultiReferenceEditor<T>

All Implemented Interfaces:

ReferenceEditorLogic<T>, CockpitEditorRenderer<java.util.Collection<T>>, ComponentWidgetAdapterAware

Direct Known Subclasses:

DefaultEnumMultiReferenceEditor, DefaultExtendedMultiReferenceEditor

public class DefaultMultiReferenceEditor<T>
extends AbstractReferenceEditor<T,java.util.Collection<T>>
implements CockpitEditorRenderer<java.util.Collection<T>>

Reference editor

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	COCKPIT_PROPERTY_MULTI_REFERENCE_EDITOR_RENDER_ON_DEMAND_SIZE
static java.lang.String	COCKPIT_PROPERTY_SELECTED_ITEMS_MAX_SIZE
protected CockpitProperties	cockpitProperties
static java.lang.String	PARAM_RENDER_ON_DEMAND_SIZE
static java.lang.String	PARAM_SELECTED_ITEMS_MAX_SIZE
protected static java.lang.String	SELECTED_ITEMS_TYPE_COLLECTION
protected static java.lang.String	SELECTED_ITEMS_TYPE_LIST
protected static java.lang.String	SELECTED_ITEMS_TYPE_SET
protected java.util.Collection<T>	selectedItems

Fields inherited from class com.hybris.cockpitng.editor.commonreferenceeditor.AbstractReferenceEditor

editorLayout, pageable, pageSize, PARAM_AVAILABLE_VALUES_PROVIDER, PARAM_CREATE_ONLY, PARAM_DISABLE_DISPLAYING_DETAILS, PARAM_DISABLE_REMOVE_REFERENCE, PARAM_LABEL_PROVIDER_BEAN, PARAM_NESTED_CREATION_DISABLED, PARAM_PAGE_SIZE, PARAM_PLACEHOLDER_KEY, PARAM_REDIRECT_REFERENCE_SELECTED_SOCKET_ID, PARAM_REFERENCE_ADVANCED_SEARCH_ENABLED, PARAM_RESTRICT_TO_TYPE, PARAM_WHITELISTED_TYPES, PARENT_OBJECT, renderOnDemandSize, selectedItemsMaxSize, SOCKET_IN_REFERENCE_EDITOR, SOCKET_OUT_REFERENCE_EDITOR, SOCKET_OUT_REFERENCE_SEARCH_CTX, SOCKET_OUT_REFRENCE_SELECTED, TYPE_CODE

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

INITIAL_EDIT_STRING

Constructor Summary

Constructors

Constructor	Description
DefaultMultiReferenceEditor()

Method Summary

Modifier and Type	Method	Description
void	addSelectedObject(T obj)	Inform editor that user select new object
protected void	changeSelectedObject(java.util.Collection<T> list)
protected void	extractRenderOnDemandSize(java.util.Map<java.lang.String,java.lang.Object> parametersFromConfig)
protected void	extractSelectedItemsMaxSize(java.util.Map<java.lang.String,java.lang.Object> parametersFromConfig)
protected java.lang.String	getCollectionType(java.lang.String valueType)
protected java.util.regex.Pattern	getRegexEditorPattern()	The pattern should match when the editor may be applied.
protected void	initializeSelectedItemsCollection(java.lang.String collectionType)
boolean	isEditable()
void	openReferenceAdvancedSearch(java.util.Collection<T> currentlySelected)	Sends a socked event on AbstractReferenceEditor.SOCKET_OUT_REFERENCE_SEARCH_CTX
java.lang.String	readTypeCode(java.lang.String valueType)
void	refreshObjects(java.util.Collection<T> objects)	Informs editor to update objects in model
void	removeSelectedObject(T obj)	Inform editor that user remove object from selected items list
void	render(org.zkoss.zk.ui.Component parent, EditorContext<java.util.Collection<T>> context, EditorListener<java.util.Collection<T>> listener)	Creates a new editor component and attaches it to the specified Component component.
protected void	setCommonEditorParameters(java.util.Map<java.lang.String,java.lang.Object> parametersFromConfig)
protected void	setEditorParameters(EditorContext<java.util.Collection<T>> context)
protected void	setInitialValue(EditorContext<java.util.Collection<T>> context)

Methods inherited from class com.hybris.cockpitng.editor.commonreferenceeditor.AbstractReferenceEditor

allowNestedObjectCreation, createInputSocketEventListener, createNewReference, createNewReference, createReferenceLayout, extractPageSize, findAncestorEditor, getCockpitConfigurationService, getCockpitUserService, getCustomValuesProviderBeanId, getEditorContext, getEditorLayout, getEditorListener, getLabelProvider, getLabelProviderBeanName, getLabelService, getObjectFacade, getPageable, getParentEditor, getParentObject, getPermissionFacade, getPlaceholderKey, getPropertyValueService, getRedirectReferenceSelectedToParentWidget, getReferenceEditorSearchConditionHandler, getReferenceEditorSearchFacade, getReferenceSearchConditions, getReferenceSearchContextMap, getStringRepresentationOfObject, getSuccessNotificationId, getTypeCode, getTypeFacade, isDisableDisplayingDetails, isDisableRemoveReference, isOnlyCreateMode, isReferenceAdvancedSearchEnabled, loadBaseConfiguration, loadBaseConfiguration, loadSimpleSearchConfiguration, preserveFocus, resolveTypeToCreate, restrictTypeCode, setCreateOnly, setEditorContext, setEditorLayout, setEditorListener, setLabelProviderBeanName, setNestedObjectCreationDisabled, setPageSize, setParentEditor, setParentObject, setReferenceSearchConditions, setRenderOnDemandSize, setSelectedItemsMaxSize, setSuccessNotificationId, setTypeCode, triggerReferenceSelected, updateReferencesListBoxModel, updateReferencesListBoxModel

Methods inherited from class com.hybris.cockpitng.engine.impl.AbstractComponentWidgetAdapterAware

addSocketInputEventListener, getComponentID, handleSocketInputEvent, initialize, initializeDefaultEventListeners, registerStubInstance, sendOutput, setComponentID, unregisterStubInstance

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hybris.cockpitng.editor.commonreferenceeditor.ReferenceEditorLogic

forwardEditorEvent

Field Detail

PARAM_SELECTED_ITEMS_MAX_SIZE

public static final java.lang.String PARAM_SELECTED_ITEMS_MAX_SIZE

See Also:

Constant Field Values

PARAM_RENDER_ON_DEMAND_SIZE

public static final java.lang.String PARAM_RENDER_ON_DEMAND_SIZE

See Also:

Constant Field Values

COCKPIT_PROPERTY_MULTI_REFERENCE_EDITOR_RENDER_ON_DEMAND_SIZE

public static final java.lang.String COCKPIT_PROPERTY_MULTI_REFERENCE_EDITOR_RENDER_ON_DEMAND_SIZE

See Also:

Constant Field Values

COCKPIT_PROPERTY_SELECTED_ITEMS_MAX_SIZE

public static final java.lang.String COCKPIT_PROPERTY_SELECTED_ITEMS_MAX_SIZE

See Also:

Constant Field Values

SELECTED_ITEMS_TYPE_COLLECTION

protected static final java.lang.String SELECTED_ITEMS_TYPE_COLLECTION

See Also:

Constant Field Values

SELECTED_ITEMS_TYPE_LIST

protected static final java.lang.String SELECTED_ITEMS_TYPE_LIST

See Also:

Constant Field Values

SELECTED_ITEMS_TYPE_SET

protected static final java.lang.String SELECTED_ITEMS_TYPE_SET

See Also:

Constant Field Values

selectedItems

protected java.util.Collection<T> selectedItems

cockpitProperties

@Autowired
protected CockpitProperties cockpitProperties

Constructor Detail

DefaultMultiReferenceEditor

public DefaultMultiReferenceEditor()

Method Detail

render

public void render(org.zkoss.zk.ui.Component parent,
                   EditorContext<java.util.Collection<T>> context,
                   EditorListener<java.util.Collection<T>> listener)

Description copied from interface: CockpitEditorRenderer

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

Specified by:

render in interface CockpitEditorRenderer<T>

Parameters:

parent - parent component the editor should be attached to

context - the context for the editor creation

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

setEditorParameters

protected void setEditorParameters(EditorContext<java.util.Collection<T>> context)

setInitialValue

protected void setInitialValue(EditorContext<java.util.Collection<T>> context)

readTypeCode

public java.lang.String readTypeCode(java.lang.String valueType)

Specified by:

readTypeCode in class AbstractReferenceEditor<T,java.util.Collection<T>>

getCollectionType

protected java.lang.String getCollectionType(java.lang.String valueType)

initializeSelectedItemsCollection

protected void initializeSelectedItemsCollection(java.lang.String collectionType)

changeSelectedObject

protected void changeSelectedObject(java.util.Collection<T> list)

addSelectedObject

public void addSelectedObject(T obj)

Description copied from interface: ReferenceEditorLogic

Inform editor that user select new object

Specified by:

addSelectedObject in interface ReferenceEditorLogic<T>

removeSelectedObject

public void removeSelectedObject(T obj)

Description copied from interface: ReferenceEditorLogic

Inform editor that user remove object from selected items list

Specified by:

removeSelectedObject in interface ReferenceEditorLogic<T>

refreshObjects

public void refreshObjects(java.util.Collection<T> objects)

Description copied from interface: ReferenceEditorLogic

Informs editor to update objects in model

Specified by:

refreshObjects in interface ReferenceEditorLogic<T>

isEditable

public boolean isEditable()

Specified by:

isEditable in interface ReferenceEditorLogic<T>

Returns:

whether editor is in editable or readonly state

getRegexEditorPattern

protected java.util.regex.Pattern getRegexEditorPattern()

Description copied from class: AbstractReferenceEditor

The pattern should match when the editor may be applied. If the pattern's matcher matches it should guarantee that group(1) on it's matcher returns the type code.

Specified by:

getRegexEditorPattern in class AbstractReferenceEditor<T,java.util.Collection<T>>

Returns:

Pattern that identifies the editor

See Also:

Pattern, Matcher

setCommonEditorParameters

protected void setCommonEditorParameters(java.util.Map<java.lang.String,java.lang.Object> parametersFromConfig)

Overrides:

setCommonEditorParameters in class AbstractReferenceEditor<T,java.util.Collection<T>>

extractSelectedItemsMaxSize

protected void extractSelectedItemsMaxSize(java.util.Map<java.lang.String,java.lang.Object> parametersFromConfig)

extractRenderOnDemandSize

protected void extractRenderOnDemandSize(java.util.Map<java.lang.String,java.lang.Object> parametersFromConfig)

openReferenceAdvancedSearch

public void openReferenceAdvancedSearch(java.util.Collection<T> currentlySelected)

Description copied from interface: ReferenceEditorLogic

Sends a socked event on AbstractReferenceEditor.SOCKET_OUT_REFERENCE_SEARCH_CTX

Specified by:

openReferenceAdvancedSearch in interface ReferenceEditorLogic<T>

Overrides:

openReferenceAdvancedSearch in class AbstractReferenceEditor<T,java.util.Collection<T>>