java.lang.Object
- com.hybris.cockpitng.engine.impl.AbstractComponentWidgetAdapterAware
- - com.hybris.cockpitng.editor.commonreferenceeditor.AbstractReferenceEditor<T,K>

All Implemented Interfaces:

ReferenceEditorLogic<T>, ComponentWidgetAdapterAware

Direct Known Subclasses:

DefaultMultiReferenceEditor, DefaultReferenceEditor
```
public abstract class AbstractReferenceEditor<T,K>
extends AbstractComponentWidgetAdapterAware
implements ReferenceEditorLogic<T>
```
Base class for DefaultReferenceEditor and DefaultMultiReferenceEditor

Field Summary

Fields
Modifier and Type	Field	Description
`protected ReferenceEditorLayout<T>`	`editorLayout`
`protected Pageable<T>`	`pageable`
`protected int`	`pageSize`
`static java.lang.String`	`PARAM_AVAILABLE_VALUES_PROVIDER`
`static java.lang.String`	`PARAM_CREATE_ONLY`
`static java.lang.String`	`PARAM_DISABLE_DISPLAYING_DETAILS`
`static java.lang.String`	`PARAM_DISABLE_REMOVE_REFERENCE`
`static java.lang.String`	`PARAM_LABEL_PROVIDER_BEAN`
`static java.lang.String`	`PARAM_NESTED_CREATION_DISABLED`
`static java.lang.String`	`PARAM_PAGE_SIZE`
`static java.lang.String`	`PARAM_PLACEHOLDER_KEY`
`static java.lang.String`	`PARAM_REDIRECT_REFERENCE_SELECTED_SOCKET_ID`
`static java.lang.String`	`PARAM_REFERENCE_ADVANCED_SEARCH_ENABLED`
`static java.lang.String`	`PARAM_RESTRICT_TO_TYPE`
`static java.lang.String`	`PARAM_WHITELISTED_TYPES`
`static java.lang.String`	`PARENT_OBJECT`
`protected int`	`renderOnDemandSize`
`protected int`	`selectedItemsMaxSize`
`protected static java.lang.String`	`SOCKET_IN_REFERENCE_EDITOR`
`protected static java.lang.String`	`SOCKET_OUT_REFERENCE_EDITOR`
`protected static java.lang.String`	`SOCKET_OUT_REFERENCE_SEARCH_CTX`
`protected static java.lang.String`	`SOCKET_OUT_REFRENCE_SELECTED`
`static java.lang.String`	`TYPE_CODE`

Constructor Summary

Constructors
Constructor Description

AbstractReferenceEditor()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`allowNestedObjectCreation()`	Determines if nested object creation controlls should be rendered.
`protected org.zkoss.zk.ui.event.EventListener`	`createInputSocketEventListener()`
`void`	`createNewReference()`	Creates new object within the context.
`void`	`createNewReference(java.lang.String type)`	Creates new object within the context.
`ReferenceEditorLayout<T>`	`createReferenceLayout(EditorContext context)`
`protected int`	`extractPageSize(java.lang.Object parameterPageSize)`	Tries to extract page size from the object passed.
`protected Editor`	`findAncestorEditor(org.zkoss.zk.ui.Component component)`	find first component in hierarchy which is an Editor
`CockpitConfigurationService`	`getCockpitConfigurationService()`
`CockpitUserService`	`getCockpitUserService()`
`protected java.lang.String`	`getCustomValuesProviderBeanId()`	Extracts from editor parameters bean id of available values provider `PARAM_AVAILABLE_VALUES_PROVIDER`.
`EditorContext<K>`	`getEditorContext()`
`ReferenceEditorLayout<T>`	`getEditorLayout()`
`EditorListener<K>`	`getEditorListener()`
`java.util.Optional<LabelProvider<T>>`	`getLabelProvider()`
`protected java.util.Optional<java.lang.String>`	`getLabelProviderBeanName()`
`LabelService`	`getLabelService()`
`ObjectFacade`	`getObjectFacade()`
`Pageable<T>`	`getPageable()`
`protected Editor`	`getParentEditor()`
`java.lang.Object`	`getParentObject()`
`PermissionFacade`	`getPermissionFacade()`
`java.lang.String`	`getPlaceholderKey()`
`PropertyValueService`	`getPropertyValueService()`
`protected java.lang.String`	`getRedirectReferenceSelectedToParentWidget()`
`ReferenceEditorSearchConditionHandler`	`getReferenceEditorSearchConditionHandler()`
`ReferenceEditorSearchFacade<T>`	`getReferenceEditorSearchFacade()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getReferenceSearchConditions()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getReferenceSearchContextMap()`
`protected abstract java.util.regex.Pattern`	`getRegexEditorPattern()`	The pattern should match when the editor may be applied.
`java.lang.String`	`getStringRepresentationOfObject(T obj)`
`java.lang.String`	`getSuccessNotificationId()`
`java.lang.String`	`getTypeCode()`
`TypeFacade`	`getTypeFacade()`
`boolean`	`isDisableDisplayingDetails()`
`boolean`	`isDisableRemoveReference()`
`boolean`	`isOnlyCreateMode()`	Determines if choosing existing item is possible.
`boolean`	`isReferenceAdvancedSearchEnabled()`	Tells if search button should open advanced reference search in a popup.
`protected Base`	`loadBaseConfiguration(java.lang.String typeCode, EditorContext<T> context)`
`protected Base`	`loadBaseConfiguration(java.lang.String typeCode, WidgetInstanceManager wim)`
`protected SimpleSearch`	`loadSimpleSearchConfiguration()`	Loads cockpit configuration for simple-search for the given typeCode
`void`	`openReferenceAdvancedSearch(java.util.Collection<T> currentlySelected)`	Sends a socked event on `SOCKET_OUT_REFERENCE_SEARCH_CTX`
`void`	`preserveFocus()`	Sets focus on parent editor
`abstract java.lang.String`	`readTypeCode(java.lang.String valueType)`
`protected java.lang.String`	`resolveTypeToCreate(java.lang.String type)`
`protected void`	`restrictTypeCode(java.lang.Object restrictToTypeValue)`
`protected void`	`setCommonEditorParameters(java.util.Map<java.lang.String,java.lang.Object> parametersFromConfig)`
`void`	`setCreateOnly(boolean createOnly)`
`void`	`setEditorContext(EditorContext<K> editorContext)`
`protected void`	`setEditorLayout(ReferenceEditorLayout<T> editorLayout)`
`void`	`setEditorListener(EditorListener<K> editorListener)`
`void`	`setLabelProviderBeanName(java.lang.Object labelProviderBeanName)`
`void`	`setNestedObjectCreationDisabled(boolean nestedCreationDisabled)`
`protected void`	`setPageSize(int pageSize)`
`protected void`	`setParentEditor(Editor parentEditor)`
`void`	`setParentObject(java.lang.Object parentObject)`
`void`	`setReferenceSearchConditions(java.util.Map<java.lang.String,java.lang.Object> referenceSearchConditions)`
`protected void`	`setRenderOnDemandSize(int renderOnDemandSize)`
`protected void`	`setSelectedItemsMaxSize(int size)`
`void`	`setSuccessNotificationId(java.lang.String successNotificationId)`
`protected void`	`setTypeCode(java.lang.String typeCode)`
`void`	`triggerReferenceSelected(java.lang.Object selected)`	Triggers selected reference socktet output to outside widgets
`void`	`updateReferencesListBoxModel()`	Perform search for all elements and refresh paging component
`void`	`updateReferencesListBoxModel(java.lang.String textQuery)`	Updates search state based on the given text query.

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
addSelectedObject, forwardEditorEvent, isEditable, refreshObjects, removeSelectedObject

- Field Detail
  - TYPE_CODE
```
public static final java.lang.String TYPE_CODE
```
    See Also:
    
    Constant Field Values
  - PARENT_OBJECT
```
public static final java.lang.String PARENT_OBJECT
```
    See Also:
    
    Constant Field Values
  - PARAM_PAGE_SIZE
```
public static final java.lang.String PARAM_PAGE_SIZE
```
    See Also:
    
    Constant Field Values
  - PARAM_AVAILABLE_VALUES_PROVIDER
```
public static final java.lang.String PARAM_AVAILABLE_VALUES_PROVIDER
```
    See Also:
    
    Constant Field Values
  - PARAM_RESTRICT_TO_TYPE
```
public static final java.lang.String PARAM_RESTRICT_TO_TYPE
```
    See Also:
    
    Constant Field Values
  - PARAM_DISABLE_DISPLAYING_DETAILS
```
public static final java.lang.String PARAM_DISABLE_DISPLAYING_DETAILS
```
    See Also:
    
    Constant Field Values
  - PARAM_PLACEHOLDER_KEY
```
public static final java.lang.String PARAM_PLACEHOLDER_KEY
```
    See Also:
    
    Constant Field Values
  - PARAM_DISABLE_REMOVE_REFERENCE
```
public static final java.lang.String PARAM_DISABLE_REMOVE_REFERENCE
```
    See Also:
    
    Constant Field Values
  - PARAM_NESTED_CREATION_DISABLED
```
public static final java.lang.String PARAM_NESTED_CREATION_DISABLED
```
    See Also:
    
    Constant Field Values
  - PARAM_CREATE_ONLY
```
public static final java.lang.String PARAM_CREATE_ONLY
```
    See Also:
    
    Constant Field Values
  - PARAM_REFERENCE_ADVANCED_SEARCH_ENABLED
```
public static final java.lang.String PARAM_REFERENCE_ADVANCED_SEARCH_ENABLED
```
    See Also:
    
    Constant Field Values
  - PARAM_REDIRECT_REFERENCE_SELECTED_SOCKET_ID
```
public static final java.lang.String PARAM_REDIRECT_REFERENCE_SELECTED_SOCKET_ID
```
    See Also:
    
    Constant Field Values
  - PARAM_WHITELISTED_TYPES
```
public static final java.lang.String PARAM_WHITELISTED_TYPES
```
    See Also:
    
    Constant Field Values
  - PARAM_LABEL_PROVIDER_BEAN
```
public static final java.lang.String PARAM_LABEL_PROVIDER_BEAN
```
    See Also:
    
    Constant Field Values
  - SOCKET_IN_REFERENCE_EDITOR
```
protected static final java.lang.String SOCKET_IN_REFERENCE_EDITOR
```
    See Also:
    
    Constant Field Values
  - SOCKET_OUT_REFERENCE_EDITOR
```
protected static final java.lang.String SOCKET_OUT_REFERENCE_EDITOR
```
    See Also:
    
    Constant Field Values
  - SOCKET_OUT_REFRENCE_SELECTED
```
protected static final java.lang.String SOCKET_OUT_REFRENCE_SELECTED
```
    See Also:
    
    Constant Field Values
  - SOCKET_OUT_REFERENCE_SEARCH_CTX
```
protected static final java.lang.String SOCKET_OUT_REFERENCE_SEARCH_CTX
```
    See Also:
    
    Constant Field Values
  - editorLayout
```
protected ReferenceEditorLayout<T> editorLayout
```
  - pageSize
```
protected int pageSize
```
  - selectedItemsMaxSize
```
protected int selectedItemsMaxSize
```
  - renderOnDemandSize
```
protected int renderOnDemandSize
```
  - pageable
```
protected Pageable<T> pageable
```
- Constructor Detail
  - AbstractReferenceEditor
```
public AbstractReferenceEditor()
```
- Method Detail
  - getPageable
```
public Pageable<T> getPageable()
```
    Specified by:
    
    getPageable in interface ReferenceEditorLogic<T>
    
    Returns:
    
    the pageable
  - updateReferencesListBoxModel
```
public void updateReferencesListBoxModel()
```
    Description copied from interface: ReferenceEditorLogic
    
    Perform search for all elements and refresh paging component
    
    Specified by:
    
    updateReferencesListBoxModel in interface ReferenceEditorLogic<T>
  - createReferenceLayout
```
public ReferenceEditorLayout<T> createReferenceLayout(EditorContext context)
```
  - loadBaseConfiguration
```
protected Base loadBaseConfiguration(java.lang.String typeCode,
                                     EditorContext<T> context)
```
  - loadBaseConfiguration
```
protected Base loadBaseConfiguration(java.lang.String typeCode,
                                     WidgetInstanceManager wim)
```
  - updateReferencesListBoxModel
```
public void updateReferencesListBoxModel(java.lang.String textQuery)
```
    Updates search state based on the given text query.
    
    Specified by:
    
    updateReferencesListBoxModel in interface ReferenceEditorLogic<T>
    
    Parameters:
    
    textQuery -
  - getReferenceSearchContextMap
```
public java.util.Map<java.lang.String,java.lang.Object> getReferenceSearchContextMap()
```
  - getStringRepresentationOfObject
```
public java.lang.String getStringRepresentationOfObject(T obj)
```
    Specified by:
    
    getStringRepresentationOfObject in interface ReferenceEditorLogic<T>
    
    Returns:
    
    Label for given object
  - loadSimpleSearchConfiguration
```
protected SimpleSearch loadSimpleSearchConfiguration()
```
    Loads cockpit configuration for simple-search for the given typeCode
    
    Returns:
    
    SimpleSearch
  - setPageSize
```
protected void setPageSize(int pageSize)
```
    Parameters:
    
    pageSize - size of the page
  - setSelectedItemsMaxSize
```
protected void setSelectedItemsMaxSize(int size)
```
  - setRenderOnDemandSize
```
protected void setRenderOnDemandSize(int renderOnDemandSize)
```
  - restrictTypeCode
```
protected void restrictTypeCode(java.lang.Object restrictToTypeValue)
```
  - setCommonEditorParameters
```
protected void setCommonEditorParameters(java.util.Map<java.lang.String,java.lang.Object> parametersFromConfig)
```
  - getSuccessNotificationId
```
public java.lang.String getSuccessNotificationId()
```
  - setSuccessNotificationId
```
public void setSuccessNotificationId(java.lang.String successNotificationId)
```
  - extractPageSize
```
protected int extractPageSize(java.lang.Object parameterPageSize)
```
    Tries to extract page size from the object passed. In case of failure returns DEFAULT_PAGE_SIZE
  - readTypeCode
```
public abstract java.lang.String readTypeCode(java.lang.String valueType)
```
  - getRegexEditorPattern
```
protected abstract java.util.regex.Pattern getRegexEditorPattern()
```
    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.
    
    Returns:
    
    Pattern that identifies the editor
    
    See Also:
    
    Pattern, Matcher
  - getReferenceEditorSearchFacade
```
public ReferenceEditorSearchFacade<T> getReferenceEditorSearchFacade()
```
    Returns:
    
    the referenceEditorSearchFacade
  - getPermissionFacade
```
public PermissionFacade getPermissionFacade()
```
  - getTypeFacade
```
public TypeFacade getTypeFacade()
```
  - getPropertyValueService
```
public PropertyValueService getPropertyValueService()
```
  - getObjectFacade
```
public ObjectFacade getObjectFacade()
```
  - getCockpitConfigurationService
```
public CockpitConfigurationService getCockpitConfigurationService()
```
  - getLabelService
```
public LabelService getLabelService()
```
    Returns:
    
    the labelService
  - getLabelProvider
```
public java.util.Optional<LabelProvider<T>> getLabelProvider()
```
  - getEditorLayout
```
public ReferenceEditorLayout<T> getEditorLayout()
```
    Returns:
    
    the editorLayout
  - setEditorLayout
```
protected void setEditorLayout(ReferenceEditorLayout<T> editorLayout)
```
    Parameters:
    
    editorLayout - the editorLayout to set
  - getTypeCode
```
public java.lang.String getTypeCode()
```
    Specified by:
    
    getTypeCode in interface ReferenceEditorLogic<T>
    
    Returns:
    
    the typeCode
  - setTypeCode
```
protected void setTypeCode(java.lang.String typeCode)
```
    Parameters:
    
    typeCode - the typeCode to set
  - isDisableDisplayingDetails
```
public boolean isDisableDisplayingDetails()
```
    Specified by:
    
    isDisableDisplayingDetails in interface ReferenceEditorLogic<T>
  - isDisableRemoveReference
```
public boolean isDisableRemoveReference()
```
    Specified by:
    
    isDisableRemoveReference in interface ReferenceEditorLogic<T>
  - getParentEditor
```
protected Editor getParentEditor()
```
    Returns:
    
    the parentEditor
  - setParentEditor
```
protected void setParentEditor(Editor parentEditor)
```
    Parameters:
    
    parentEditor - the parentEditor to set
  - createInputSocketEventListener
```
protected org.zkoss.zk.ui.event.EventListener createInputSocketEventListener()
```
    Returns:
  - createNewReference
```
public void createNewReference()
```
    Description copied from interface: ReferenceEditorLogic
    
    Creates new object within the context.
    
    Specified by:
    
    createNewReference in interface ReferenceEditorLogic<T>
  - createNewReference
```
public void createNewReference(java.lang.String type)
```
    Description copied from interface: ReferenceEditorLogic
    
    Creates new object within the context.
    
    Specified by:
    
    createNewReference in interface ReferenceEditorLogic<T>
  - resolveTypeToCreate
```
protected java.lang.String resolveTypeToCreate(java.lang.String type)
```
  - setNestedObjectCreationDisabled
```
public void setNestedObjectCreationDisabled(boolean nestedCreationDisabled)
```
  - setCreateOnly
```
public void setCreateOnly(boolean createOnly)
```
  - isOnlyCreateMode
```
public boolean isOnlyCreateMode()
```
    Description copied from interface: ReferenceEditorLogic
    
    Determines if choosing existing item is possible.
    
    Specified by:
    
    isOnlyCreateMode in interface ReferenceEditorLogic<T>
    
    Returns:
  - allowNestedObjectCreation
```
public boolean allowNestedObjectCreation()
```
    Description copied from interface: ReferenceEditorLogic
    
    Determines if nested object creation controlls should be rendered.
    
    Specified by:
    
    allowNestedObjectCreation in interface ReferenceEditorLogic<T>
    
    Returns:
  - triggerReferenceSelected
```
public void triggerReferenceSelected(java.lang.Object selected)
```
    Description copied from interface: ReferenceEditorLogic
    
    Triggers selected reference socktet output to outside widgets
    
    Specified by:
    
    triggerReferenceSelected in interface ReferenceEditorLogic<T>
    
    Parameters:
    
    selected - reference currently selected
  - getRedirectReferenceSelectedToParentWidget
```
protected java.lang.String getRedirectReferenceSelectedToParentWidget()
```
  - openReferenceAdvancedSearch
```
public void openReferenceAdvancedSearch(java.util.Collection<T> currentlySelected)
```
    Description copied from interface: ReferenceEditorLogic
    
    Sends a socked event on SOCKET_OUT_REFERENCE_SEARCH_CTX
    
    Specified by:
    
    openReferenceAdvancedSearch in interface ReferenceEditorLogic<T>
  - isReferenceAdvancedSearchEnabled
```
public boolean isReferenceAdvancedSearchEnabled()
```
    Description copied from interface: ReferenceEditorLogic
    
    Tells if search button should open advanced reference search in a popup.
    
    Specified by:
    
    isReferenceAdvancedSearchEnabled in interface ReferenceEditorLogic<T>
  - getCustomValuesProviderBeanId
```
protected java.lang.String getCustomValuesProviderBeanId()
```
    Extracts from editor parameters bean id of available values provider PARAM_AVAILABLE_VALUES_PROVIDER.
    
    Returns:
    
    bean id if parameter value is not blank String or null.
  - getParentObject
```
public java.lang.Object getParentObject()
```
  - setParentObject
```
public void setParentObject(java.lang.Object parentObject)
```
  - findAncestorEditor
```
protected Editor findAncestorEditor(org.zkoss.zk.ui.Component component)
```
    find first component in hierarchy which is an Editor
    
    Parameters:
    
    component -
    
    Returns:
  - getPlaceholderKey
```
public java.lang.String getPlaceholderKey()
```
  - getEditorContext
```
public EditorContext<K> getEditorContext()
```
  - setEditorContext
```
public void setEditorContext(EditorContext<K> editorContext)
```
  - getEditorListener
```
public EditorListener<K> getEditorListener()
```
  - setEditorListener
```
public void setEditorListener(EditorListener<K> editorListener)
```
  - getReferenceSearchConditions
```
public java.util.Map<java.lang.String,java.lang.Object> getReferenceSearchConditions()
```
  - setReferenceSearchConditions
```
public void setReferenceSearchConditions(java.util.Map<java.lang.String,java.lang.Object> referenceSearchConditions)
```
  - getLabelProviderBeanName
```
protected java.util.Optional<java.lang.String> getLabelProviderBeanName()
```
  - setLabelProviderBeanName
```
public void setLabelProviderBeanName(java.lang.Object labelProviderBeanName)
```
  - getReferenceEditorSearchConditionHandler
```
public ReferenceEditorSearchConditionHandler getReferenceEditorSearchConditionHandler()
```
  - getCockpitUserService
```
public CockpitUserService getCockpitUserService()
```
  - preserveFocus
```
public void preserveFocus()
```
    Description copied from interface: ReferenceEditorLogic
    
    Sets focus on parent editor
    
    Specified by:
    
    preserveFocus in interface ReferenceEditorLogic<T>

Class AbstractReferenceEditor<T,​K>

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_CODE

PARENT_OBJECT

PARAM_PAGE_SIZE

PARAM_AVAILABLE_VALUES_PROVIDER

PARAM_RESTRICT_TO_TYPE

PARAM_DISABLE_DISPLAYING_DETAILS

PARAM_PLACEHOLDER_KEY

PARAM_DISABLE_REMOVE_REFERENCE

PARAM_NESTED_CREATION_DISABLED

PARAM_CREATE_ONLY

PARAM_REFERENCE_ADVANCED_SEARCH_ENABLED

PARAM_REDIRECT_REFERENCE_SELECTED_SOCKET_ID

PARAM_WHITELISTED_TYPES

PARAM_LABEL_PROVIDER_BEAN

SOCKET_IN_REFERENCE_EDITOR

SOCKET_OUT_REFERENCE_EDITOR

SOCKET_OUT_REFRENCE_SELECTED

SOCKET_OUT_REFERENCE_SEARCH_CTX

editorLayout

pageSize

selectedItemsMaxSize

renderOnDemandSize

pageable

Constructor Detail

AbstractReferenceEditor

Method Detail

getPageable

updateReferencesListBoxModel

createReferenceLayout

loadBaseConfiguration

loadBaseConfiguration

updateReferencesListBoxModel

getReferenceSearchContextMap

getStringRepresentationOfObject

loadSimpleSearchConfiguration

setPageSize

setSelectedItemsMaxSize

setRenderOnDemandSize

restrictTypeCode

setCommonEditorParameters

getSuccessNotificationId

setSuccessNotificationId

extractPageSize

readTypeCode

getRegexEditorPattern

getReferenceEditorSearchFacade

getPermissionFacade

getTypeFacade

getPropertyValueService

getObjectFacade

getCockpitConfigurationService

getLabelService

getLabelProvider

getEditorLayout

setEditorLayout

getTypeCode

setTypeCode

isDisableDisplayingDetails

isDisableRemoveReference

getParentEditor

setParentEditor

createInputSocketEventListener

createNewReference

createNewReference

resolveTypeToCreate

setNestedObjectCreationDisabled

setCreateOnly

isOnlyCreateMode

allowNestedObjectCreation

triggerReferenceSelected

getRedirectReferenceSelectedToParentWidget

openReferenceAdvancedSearch

Class AbstractReferenceEditor<T,K>