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
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected classprotected static interfaceprotected class -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final StringDeprecated.since 6.3protected booleanprotected Objectprotected Stringstatic final Stringstatic final StringFields inherited from interface de.hybris.platform.cockpit.model.editor.UIEditor
INITIAL_EDIT_STRING -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic CreateContextapplyReferenceRelatedAttributes(ReferenceUIEditor referenceEditor, PropertyDescriptor propertyDescriptor, Map<String, ? extends Object> parameters, TypedObject currentObject, Object currentValue, String isoCode, UICockpitArea cockpitArea, UISession session) Deprecated.since 6.3static voidcreateEditor(TypedObject item, PropertyDescriptor propDescr, org.zkoss.zk.ui.HtmlBasedComponent parent, ObjectValueContainer valueContainer, boolean autoPersist) Deprecated.since 6.3static voidcreateEditor(TypedObject item, PropertyDescriptor propDescr, org.zkoss.zk.ui.HtmlBasedComponent parent, ObjectValueContainer valueContainer, boolean autoPersist, String editorCode) Deprecated.since 6.3static voidcreateEditor(TypedObject item, PropertyDescriptor propDescr, org.zkoss.zk.ui.HtmlBasedComponent parent, ObjectValueContainer valueContainer, boolean autoPersist, String editorCode, Map<String, ? extends Object> params) Deprecated.since 6.3static voidcreateEditor(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.3static <T> List<? extends T>filterValues(PropertyDescriptor propDescr, List<? extends T> values) Deprecated.since 6.3protected voidfireValueChanged(EditorListener listener) static SearchTypegetRootSearchType(PropertyDescriptor propDescr, UISession session) Deprecated.since 6.3static UIEditorgetUIEditor(PropertyDescriptor propDescr, String editorCode) Deprecated.since 6.3getValue()Returns the value held by this editor.booleanReturns whether this editor is editable or notstatic booleanisEditable(PropertyDescriptor propDescr, boolean creationMode) Deprecated.since 6.3, useUIAccessRightService's isWritable methods instead.booleanprotected booleanisSearchMode(Map<String, ? extends Object> parameters) protected voidparseInitialInputString(Map<String, ? extends Object> parameters) static final Set<ObjectType>parseTemplateCodes(String input, TypeService typeService) Deprecated.static voidpersistValues(TypedObject item, ObjectValueContainer valueContainer) Deprecated.since 6.3static voidpersistValues(TypedObject item, ObjectValueContainer valueContainer, Map<String, ? extends Object> params) Deprecated.since 6.3voidsetEditable(boolean editable) Defines whether this editor shall be editable.voidsetFocus(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 itvoidsetOptional(boolean optional) voidSets the value of this editor tovalue.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface de.hybris.platform.cockpit.model.editor.UIEditor
createViewComponent, getEditorType, isInline
-
Field Details
-
EVENT_SOURCE
Deprecated.since 6.3- See Also:
-
CANCEL_BTN
- See Also:
-
ATTRIBUTE_QUALIFIER_PARAM
- See Also:
-
PROPERTY_DESCRIPTOR_PARAM
- See Also:
-
SEARCH_MODE_PARAM
- See Also:
-
initialEditValue
-
inEditMode
protected boolean inEditMode -
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 IllegalArgumentExceptionDeprecated.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 IllegalArgumentExceptionDeprecated.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.3Convenience method for creating and retrieving aUIEditor. Note: If no editor variant is found with the codeeditorCode, the default editor for the specified property is returned. This method was moved toEditorHelper.getUIEditor(PropertyDescriptor, String)- Parameters:
propDescr- the property descriptor for which a corresponding editor is to be retrievededitorCode- the editor variant to be used- Returns:
- a new
UIEditorinstance for the specified property and - if available - for the specified editor variant - Throws:
IllegalArgumentException- if the property descriptor is invalid
-
isEditable
Deprecated.since 6.3, useUIAccessRightService's isWritable methods instead.Returns whether the specified property is editable or not.- Parameters:
propDescr- the property descriptor- Returns:
trueif the property is editable,falseotherwise
-
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 ValueHandlerExceptionDeprecated.since 6.3Saves current values that are gathered withinvalueContainerobject- Parameters:
item- current typed object itemvalueContainer- current value containerparams- creation parameters- Throws:
ValueHandlerException
-
fireValueChanged
-
getValue
Description copied from interface:UIEditorReturns the value held by this editor. -
isEditable
public boolean isEditable()Description copied from interface:UIEditorReturns whether this editor is editable or not- Specified by:
isEditablein interfaceUIEditor- Returns:
- true, if editable
-
isOptional
public boolean isOptional()- Specified by:
isOptionalin interfaceUIEditor
-
parseInitialInputString
-
setEditable
public void setEditable(boolean editable) Description copied from interface:UIEditorDefines whether this editor shall be editable. Has to be set before creating the view component.- Specified by:
setEditablein interfaceUIEditor- 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:UIEditorSets the focus on the given input component which can be the rootEditorComponent or a child of it -
setOptional
public void setOptional(boolean optional) - Specified by:
setOptionalin interfaceUIEditor
-
setValue
Description copied from interface:UIEditorSets the value of this editor tovalue. 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 specifiedEditorListenerthe underlying view component might generate an event which causes theEditorListener.valueChanged(Object)method to be called. -
isSearchMode
-