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

Class AbstractUIEditor

java.lang.Object

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

All Implemented Interfaces:

UIEditor

Direct Known Subclasses:

AbstractConditionUIEditor, AbstractFeatureUIEditor, AbstractReferenceUIEditor, AbstractTextBasedUIEditor, CheckboxBooleanUIEditor, DefaultBooleanUIEditor, DefaultDummyUIEditor, DefaultEnumUIEditor, DefaultImageUIEditor, DefaultMediaPreviewUIEditor, DefaultSelectUIEditor, DropdownBooleanUIEditor, GenericCollectionUIEditor, WysiwygUIEditor

public abstract class AbstractUIEditor
extends Object
implements UIEditor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractUIEditor.CancelButtonContainer
protected static interface	AbstractUIEditor.CancelListener
protected class	AbstractUIEditor.ErrorDiv

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_QUALIFIER_PARAM
static final String	CANCEL_BTN
static final String	EVENT_SOURCE	Deprecated. since 6.3
protected boolean	inEditMode
protected Object	initialEditValue
protected String	initialInputString
static final String	PROPERTY_DESCRIPTOR_PARAM
static final String	SEARCH_MODE_PARAM

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

INITIAL_EDIT_STRING

Constructor Summary

Constructors

Constructor	Description
AbstractUIEditor()

Method Summary

Modifier and Type	Method	Description
static CreateContext	applyReferenceRelatedAttributes(ReferenceUIEditor referenceEditor, PropertyDescriptor propertyDescriptor, Map<String,? extends Object> parameters, TypedObject currentObject, Object currentValue, String isoCode, UICockpitArea cockpitArea, UISession session)	Deprecated. since 6.3
static void	createEditor(TypedObject item, PropertyDescriptor propDescr, org.zkoss.zk.ui.HtmlBasedComponent parent, ObjectValueContainer valueContainer, boolean autoPersist)	Deprecated. since 6.3
static void	createEditor(TypedObject item, PropertyDescriptor propDescr, org.zkoss.zk.ui.HtmlBasedComponent parent, ObjectValueContainer valueContainer, boolean autoPersist, String editorCode)	Deprecated. since 6.3
static void	createEditor(TypedObject item, PropertyDescriptor propDescr, org.zkoss.zk.ui.HtmlBasedComponent parent, ObjectValueContainer valueContainer, boolean autoPersist, String editorCode, Map<String,? extends Object> params)	Deprecated. since 6.3
static void	createEditor(TypedObject item, PropertyDescriptor propDescr, org.zkoss.zk.ui.HtmlBasedComponent parent, ObjectValueContainer valueContainer, boolean autoPersist, String editorCode, Map<String,? extends Object> params, boolean focus)	Deprecated. since 6.3
static <T> List<? extends T>	filterValues(PropertyDescriptor propDescr, List<? extends T> values)	Deprecated. since 6.3
protected void	fireValueChanged(EditorListener listener)
static SearchType	getRootSearchType(PropertyDescriptor propDescr, UISession session)	Deprecated. since 6.3
static UIEditor	getUIEditor(PropertyDescriptor propDescr, String editorCode)	Deprecated. since 6.3
Object	getValue()	Returns the value held by this editor.
boolean	isEditable()	Returns whether this editor is editable or not
static boolean	isEditable(PropertyDescriptor propDescr, boolean creationMode)	Deprecated. since 6.3, use UIAccessRightService's isWritable methods instead.
boolean	isOptional()
protected boolean	isSearchMode(Map<String,? extends Object> parameters)
protected void	parseInitialInputString(Map<String,? extends Object> parameters)
static final Set<ObjectType>	parseTemplateCodes(String input, TypeService typeService)	Deprecated.
static void	persistValues(TypedObject item, ObjectValueContainer valueContainer)	Deprecated. since 6.3
static void	persistValues(TypedObject item, ObjectValueContainer valueContainer, Map<String,? extends Object> params)	Deprecated. since 6.3
void	setEditable(boolean editable)	Defines whether this editor shall be editable.
void	setFocus(org.zkoss.zk.ui.HtmlBasedComponent rootEditorComponent, boolean selectAll)	Sets the focus on the given input component which can be the rootEditorComponent or a child of it
void	setOptional(boolean optional)
void	setValue(Object value)	Sets the value of this editor to value.

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

createViewComponent, getEditorType, isInline

Field Details

EVENT_SOURCE

@Deprecated
public static final String EVENT_SOURCE

Deprecated.

since 6.3

See Also:

• Constant Field Values

CANCEL_BTN

public static final String CANCEL_BTN

See Also:

• Constant Field Values

ATTRIBUTE_QUALIFIER_PARAM

public static final String ATTRIBUTE_QUALIFIER_PARAM

See Also:

• Constant Field Values

PROPERTY_DESCRIPTOR_PARAM

public static final String PROPERTY_DESCRIPTOR_PARAM

See Also:

• Constant Field Values

SEARCH_MODE_PARAM

public static final String SEARCH_MODE_PARAM

See Also:

• Constant Field Values

initialEditValue

protected Object initialEditValue

inEditMode

protected boolean inEditMode

initialInputString

protected String initialInputString

Constructor Details

AbstractUIEditor

public AbstractUIEditor()

Method Details

createEditor

@Deprecated
public static void createEditor(TypedObject item,
 PropertyDescriptor propDescr,
 org.zkoss.zk.ui.HtmlBasedComponent parent,
 ObjectValueContainer valueContainer,
 boolean autoPersist)
                         throws IllegalArgumentException

Deprecated.

since 6.3

Throws:

IllegalArgumentException

createEditor

@Deprecated
public static void createEditor(TypedObject item,
 PropertyDescriptor propDescr,
 org.zkoss.zk.ui.HtmlBasedComponent parent,
 ObjectValueContainer valueContainer,
 boolean autoPersist,
 String editorCode)
                         throws IllegalArgumentException

Deprecated.

since 6.3

Throws:

IllegalArgumentException

createEditor

@Deprecated
public static void createEditor(TypedObject item,
 PropertyDescriptor propDescr,
 org.zkoss.zk.ui.HtmlBasedComponent parent,
 ObjectValueContainer valueContainer,
 boolean autoPersist,
 String editorCode,
 Map<String,? extends Object> params)
                         throws IllegalArgumentException

Deprecated.

since 6.3

Throws:

IllegalArgumentException

createEditor

@Deprecated
public static void createEditor(TypedObject item,
 PropertyDescriptor propDescr,
 org.zkoss.zk.ui.HtmlBasedComponent parent,
 ObjectValueContainer valueContainer,
 boolean autoPersist,
 String editorCode,
 Map<String,? extends Object> params,
 boolean focus)
                         throws IllegalArgumentException

Deprecated.

since 6.3

Throws:

IllegalArgumentException

applyReferenceRelatedAttributes

@Deprecated
public static CreateContext applyReferenceRelatedAttributes(ReferenceUIEditor referenceEditor,
 PropertyDescriptor propertyDescriptor,
 Map<String,? extends Object> parameters,
 TypedObject currentObject,
 Object currentValue,
 String isoCode,
 UICockpitArea cockpitArea,
 UISession session)

Deprecated.

since 6.3

filterValues

@Deprecated
public static <T> List<? extends T> filterValues(PropertyDescriptor propDescr,
 List<? extends T> values)

Deprecated.

since 6.3

getRootSearchType

@Deprecated
public static SearchType getRootSearchType(PropertyDescriptor propDescr,
 UISession session)

Deprecated.

since 6.3

getUIEditor

@Deprecated
public static UIEditor getUIEditor(PropertyDescriptor propDescr,
 String editorCode)
                            throws IllegalArgumentException

Deprecated.

since 6.3

Convenience method for creating and retrieving a UIEditor.

Note: If no editor variant is found with the code editorCode, the default editor for the specified property is returned. This method was moved to EditorHelper.getUIEditor(PropertyDescriptor, String)

Parameters:

propDescr - the property descriptor for which a corresponding editor is to be retrieved

editorCode - the editor variant to be used

Returns:

a new UIEditor instance for the specified property and - if available - for the specified editor variant

Throws:

IllegalArgumentException - if the property descriptor is invalid

isEditable

@Deprecated
public static boolean isEditable(PropertyDescriptor propDescr,
 boolean creationMode)

Deprecated.

since 6.3, use UIAccessRightService's isWritable methods instead.

Returns whether the specified property is editable or not.

Parameters:

propDescr - the property descriptor

Returns:

true if the property is editable, false otherwise

parseTemplateCodes

@Deprecated
public static final Set<ObjectType> parseTemplateCodes(String input,
 TypeService typeService)

Deprecated.

persistValues

@Deprecated
public static void persistValues(TypedObject item,
 ObjectValueContainer valueContainer)
                          throws ValueHandlerException

Deprecated.

since 6.3

Throws:

ValueHandlerException

persistValues

@Deprecated
public static void persistValues(TypedObject item,
 ObjectValueContainer valueContainer,
 Map<String,? extends Object> params)
                          throws ValueHandlerException

Deprecated.

since 6.3

Saves current values that are gathered within valueContainer object

Parameters:

item - current typed object item

valueContainer - current value container

params - creation parameters

Throws:

ValueHandlerException

fireValueChanged

protected void fireValueChanged(EditorListener listener)

getValue

public Object getValue()

Description copied from interface: UIEditor

Returns the value held by this editor.

Specified by:

getValue in interface UIEditor

Returns:

this editor's value

isEditable

public boolean isEditable()

Description copied from interface: UIEditor

Returns whether this editor is editable or not

Specified by:

isEditable in interface UIEditor

Returns:

true, if editable

isOptional

public boolean isOptional()

Specified by:

isOptional in interface UIEditor

parseInitialInputString

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

setEditable

public void setEditable(boolean editable)

Description copied from interface: UIEditor

Defines whether this editor shall be editable. Has to be set before creating the view component.

Specified by:

setEditable in interface UIEditor

Parameters:

editable - whether this editor is editable or not

setFocus

public void setFocus(org.zkoss.zk.ui.HtmlBasedComponent rootEditorComponent,
 boolean selectAll)

Description copied from interface: UIEditor

Sets the focus on the given input component which can be the rootEditorComponent or a child of it

Specified by:

setFocus in interface UIEditor

Parameters:

rootEditorComponent - the rootEditorComponent which is returned on method createViewComponent

selectAll - if true, select the whole input field after focus. It is not guaranteed that the editor supports selection.

setOptional

public void setOptional(boolean optional)

Specified by:

setOptional in interface UIEditor

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

Parameters:

value - the value to set

isSearchMode

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