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

Class SimpleReferenceUIEditor

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.impl.SimpleReferenceUIEditor

All Implemented Interfaces:

ReferenceUIEditor, UIEditor

Direct Known Subclasses:

UnitReferenceUIEditor

public class SimpleReferenceUIEditor
extends AbstractReferenceUIEditor

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

Method Summary

Modifier and Type	Method and Description
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 void	fillComboBox(Combobox combobox, TypedObject selected)
protected List<TypedObject>	getAvailableValues()
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.
protected TypeService	getTypeService()
boolean	isInline() Returns whether this editor is an inline editor or not.
protected void	parseParams(Map<String,? extends Object> parameters)
void	setAvailableValues(List<TypedObject> availableValues)
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.
protected boolean	updateAvailableValues() Deprecated. use updateAvailableValues(Map) instead.
protected boolean	updateAvailableValues(Map<String,? extends Object> parameters)

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, getValue, isEditable, isEditable, isOptional, isSearchMode, parseInitialInputString, parseTemplateCodes, persistValues, persistValues, setEditable, setFocus, setOptional, setValue

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

getValue, isEditable, isOptional, setEditable, setFocus, setOptional, setValue

Constructor Detail

SimpleReferenceUIEditor

public SimpleReferenceUIEditor()

Method Detail

updateAvailableValues

@Deprecated
protected boolean updateAvailableValues()

Deprecated. use updateAvailableValues(Map) instead.

updateAvailableValues

protected boolean updateAvailableValues(Map<String,? extends Object> parameters)

setAvailableValues

public void setAvailableValues(List<TypedObject> availableValues)

getAvailableValues

protected List<TypedObject> getAvailableValues()

fillComboBox

protected void fillComboBox(Combobox combobox,
                            TypedObject selected)

parseParams

protected void parseParams(Map<String,? extends Object> parameters)

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

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

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)

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

isInline

public boolean isInline()

Description copied from interface: UIEditor

Returns whether this editor is an inline editor or not.

Returns:

true, if inline

getTypeService

protected TypeService getTypeService()