de.hybris.platform.cscockpit.model.editor.impl

Class OverridableEnumUIEditor

java.lang.Object

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

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

de.hybris.platform.cscockpit.model.editor.impl.OverridableEnumUIEditor

All Implemented Interfaces:

EnumUIEditor, ListUIEditor, UIEditor

public class OverridableEnumUIEditor
extends DefaultEnumUIEditor

Cockpit Enum UI editor that can be configured to only allow selection from a defined sub-set of values. By default the DefaultEnumUIEditor allows any of the Enum's values to be selected. This implementation supports a custom parameter named availableValues that can pass a list of the Enum's values that should be allowed to be selected. See the cscockpit-spring-editors.xml for usage.

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.UIEditor

INITIAL_EDIT_STRING

Constructor Summary

Constructors

Constructor and Description
OverridableEnumUIEditor()

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.

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

addEnumToCombo, getAvailableValues, getEditorType, getEditorView, getPosition, isInline, setAvailableValues, setEnumValue, setFocus, setOptional, validateAndFireEvent

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

Constructor Detail

OverridableEnumUIEditor

public OverridableEnumUIEditor()

Method Detail

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.

Specified by:

createViewComponent in interface UIEditor

Overrides:

createViewComponent in class DefaultEnumUIEditor

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