Package com.hybris.cockpitng.editor.defaultreferenceeditor

Class DefaultReferenceEditor<T>

java.lang.Object

com.hybris.cockpitng.engine.impl.AbstractComponentWidgetAdapterAware

com.hybris.cockpitng.editor.commonreferenceeditor.AbstractReferenceEditor<T,T>

com.hybris.cockpitng.editor.defaultreferenceeditor.DefaultReferenceEditor<T>

All Implemented Interfaces:

ReferenceEditorLogic<T>, CockpitEditorRenderer<T>, ComponentWidgetAdapterAware

Direct Known Subclasses:

DefaultFixedReferenceEditor

public class DefaultReferenceEditor<T>
extends AbstractReferenceEditor<T,T>
implements CockpitEditorRenderer<T>

Reference editor

Field Summary

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
DefaultReferenceEditor()

Method Summary

Modifier and Type	Method	Description
void	addSelectedObject(T obj)	Inform editor that user select new object
void	forwardEditorEvent(java.lang.String eventCode)	Forwards event to editor listener.
protected java.util.regex.Pattern	getRegexEditorPattern()	The pattern should match when the editor may be applied.
boolean	isEditable()
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<T> context, EditorListener<T> listener)	Creates a new editor component and attaches it to the specified Component component.
protected void	setEditorParameters(EditorContext<T> context)
protected void	setInitialValue(EditorContext<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, openReferenceAdvancedSearch, preserveFocus, resolveTypeToCreate, restrictTypeCode, setCommonEditorParameters, 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

Constructor Detail

DefaultReferenceEditor

public DefaultReferenceEditor()

Method Detail

render

public void render(org.zkoss.zk.ui.Component parent,
                   EditorContext<T> context,
                   EditorListener<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<T> context)

setInitialValue

protected void setInitialValue(EditorContext<T> context)

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>

forwardEditorEvent

public void forwardEditorEvent(java.lang.String eventCode)

Description copied from interface: ReferenceEditorLogic

Forwards event to editor listener.

Specified by:

forwardEditorEvent in interface ReferenceEditorLogic<T>

Parameters:

eventCode - event code.

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,T>

Returns:

Pattern that identifies the editor

See Also:

Pattern, Matcher

readTypeCode

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

Specified by:

readTypeCode in class AbstractReferenceEditor<T,T>