de.hybris.platform.cockpit.model.referenceeditor.collection

Class CollectionUIEditor

java.lang.Object

de.hybris.platform.cockpit.model.editor.impl.AbstractUIEditor

de.hybris.platform.cockpit.model.referenceeditor.impl.AbstractReferenceUIEditor

de.hybris.platform.cockpit.model.referenceeditor.collection.CollectionUIEditor

All Implemented Interfaces:

ReferenceUIEditor, UIEditor

Direct Known Subclasses:

CollectionUIEditorMedia

public class CollectionUIEditor
extends AbstractReferenceUIEditor

Simplistic Reference Collection Editor.

Note:
User now is able to select some values directly from auto completed list using both mouse and keyboard - this caused that this component is more intuitive an user-friendly.

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.cockpit.model.editor.impl.AbstractUIEditor

AbstractUIEditor.CancelButtonContainer, AbstractUIEditor.CancelListener, AbstractUIEditor.ErrorDiv

Field Summary

Fields

Modifier and Type	Field and Description
protected CollectionUIEditorController	collectionController
protected CollectionEditor	collectionEditor
protected DefaultCollectionEditorModel	model

Fields inherited from class de.hybris.platform.cockpit.model.editor.impl.AbstractUIEditor

ATTRIBUTE_QUALIFIER_PARAM, CANCEL_BTN, EVENT_SOURCE, inEditMode, initialEditValue, initialInputString, PROPERTY_DESCRIPTOR_PARAM, SEARCH_MODE_PARAM

Fields inherited from interface de.hybris.platform.cockpit.model.editor.ReferenceUIEditor

ALLOW_CREATE_PARAM_KEY

Fields inherited from interface de.hybris.platform.cockpit.model.editor.UIEditor

INITIAL_EDIT_STRING

Constructor Summary

Constructors

Constructor and Description
CollectionUIEditor()
CollectionUIEditor(ObjectType rootType)

Method Summary

Modifier and Type	Method and Description
protected void	assignedPassedValue(Object initialValue) Assigns an initialValue as a editor value.
CollectionEditor	createCollectionEditor(EditorListener listener, AdditionalReferenceEditorListener additionalListener)
HtmlBasedComponent	createViewComponent(Object initialValue, Map<String,? extends Object> parameters, EditorListener listener) Creates a new editor component and attaches it to the specified Page page.
protected DefaultCollectionEditorModel	getModel()
ObjectType	getRootSearchType() Returns the type for which this reference collection editor should search for.
ObjectType	getRootType() Returns the root type of this reference collection editor i.e.
Object	getValue() Returns the value held by this editor.
boolean	isInline() Returns whether this editor is an inline editor or not.
protected void	registerEventListeners(AbstractUIEditor.CancelButtonContainer cancelButtonContainer) Registers all necessary event listeners in order to correct serve selectors events.
void	setRootSearchType(ObjectType rootSearchType) Sets the type for which this reference selector should search for.
void	setRootType(ObjectType rootType) Sets the root type of this reference editor i.e.
void	setValue(Object value) Sets the value of this editor to value.

Methods inherited from class de.hybris.platform.cockpit.model.referenceeditor.impl.AbstractReferenceUIEditor

findMaxAutocompleteSearchResults, getEditorType, isAllowCreate, setAllowCreate

Methods inherited from class de.hybris.platform.cockpit.model.editor.impl.AbstractUIEditor

applyReferenceRelatedAttributes, createEditor, createEditor, createEditor, createEditor, filterValues, fireValueChanged, getRootSearchType, getUIEditor, isEditable, isEditable, isOptional, isSearchMode, parseInitialInputString, parseTemplateCodes, persistValues, persistValues, setEditable, setFocus, setOptional

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.cockpit.model.editor.UIEditor

isEditable, isOptional, setEditable, setFocus, setOptional

Field Detail

model

protected DefaultCollectionEditorModel model

collectionEditor

protected CollectionEditor collectionEditor

collectionController

protected CollectionUIEditorController collectionController

Constructor Detail

CollectionUIEditor

public CollectionUIEditor()

CollectionUIEditor

public CollectionUIEditor(ObjectType rootType)

Method Detail

setRootType

public void setRootType(ObjectType rootType)

Description copied from interface: ReferenceUIEditor

Sets the root type of this reference editor i.e. the root type of the references which this editor holds.

Parameters:

rootType - the root type

setRootSearchType

public void setRootSearchType(ObjectType rootSearchType)

Description copied from interface: ReferenceUIEditor

Sets the type for which this reference selector should search for.

Note: Generally, if rootSearchType is null, the set root type will be used.

See Also:

ReferenceUIEditor.setRootType(ObjectType)

createViewComponent

public HtmlBasedComponent createViewComponent(Object initialValue,
                                              Map<String,? extends Object> parameters,
                                              EditorListener listener)

Description copied from interface: UIEditor

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

Parameters:

initialValue - editor's initial value

parameters - parameters passed via configuration for particular editor

listener - the EditorListener that will receive events when the editor's value is changed

Returns:

the editor component

registerEventListeners

protected void registerEventListeners(AbstractUIEditor.CancelButtonContainer cancelButtonContainer)

Registers all necessary event listeners in order to correct serve selectors events.

Parameters:

cancelButtonContainer - wrapped editor

getValue

public Object getValue()

Description copied from interface: UIEditor

Returns the value held by this editor.

Specified by:

getValue in interface UIEditor

Overrides:

getValue in class AbstractUIEditor

Returns:

this editor's value

isInline

public boolean isInline()

Description copied from interface: UIEditor

Returns whether this editor is an inline editor or not.

Returns:

true, if inline

setValue

public void setValue(Object value)

Description copied from interface: UIEditor

Sets the value of this editor to value.

Note: Does not have anything to do with value persistence, it is only for setting the value to be displayed. However, depending on the view component implementation and the specified EditorListener the underlying view component might generate an event which causes the EditorListener.valueChanged(Object) method to be called.

Specified by:

setValue in interface UIEditor

Overrides:

setValue in class AbstractUIEditor

Parameters:

value - the value to set

getRootSearchType

public ObjectType getRootSearchType()

Description copied from interface: ReferenceUIEditor

Returns the type for which this reference collection editor should search for.

Generally, if no root search type has been explicitly set, this method returns the same type as ReferenceUIEditor.getRootType().

Note: The root search type is actually the type of the items held by this editor, whereas root type is the type which should be used for persisting values.

Returns:

the type for which this reference collection editor should search for

See Also:

ReferenceUIEditor.getRootType()

getRootType

public ObjectType getRootType()

Description copied from interface: ReferenceUIEditor

Returns the root type of this reference collection editor i.e. the type of the items which this editor should hold references to.

Note: If the root search type differs from the root type, this editor will actually hold items of the type returned by ReferenceUIEditor.getRootSearchType(). In this case information about the root type is generally needed for value handling.

Returns:

the root type of this editor

See Also:

ReferenceUIEditor.getRootSearchType()

getModel

protected DefaultCollectionEditorModel getModel()

assignedPassedValue

protected void assignedPassedValue(Object initialValue)

Assigns an initialValue as a editor value.

Parameters:

initialValue - editor's current initial value

createCollectionEditor

public CollectionEditor createCollectionEditor(EditorListener listener,
                                               AdditionalReferenceEditorListener additionalListener)