Interface ReferenceUIEditor
- All Superinterfaces:
UIEditor
- All Known Implementing Classes:
AbstractReferenceUIEditor,BaseStoreCheckboxUIEditor,CategoryVersionRadioEditor,CelumMediaCollectionUIEditor,CelumMediaReferenceCollectionUIEditor,CelumMediaReferenceUIEditor,CelumSimpleMediaReferenceUIEditor,CollectionUIEditor,CollectionUIEditorMedia,ContextAreaReferenceCollectionUIEditor,DefaultMediaReferenceCollectionUIEditor,DefaultMediaReferenceUIEditor,DefaultReferenceCollectionUIEditor,DefaultReferenceUIEditor,DefaultSimpleMediaReferenceUIEditor,DefaultSimpleReferenceUIEditor,ListViewCollectionEditor,MinimalReferenceUIEditor,SimpleReferenceUIEditor,UnitReferenceUIEditor
Reference editor interface.
-
Field Summary
FieldsFields inherited from interface de.hybris.platform.cockpit.model.editor.UIEditor
INITIAL_EDIT_STRING -
Method Summary
Modifier and TypeMethodDescriptionReturns the type for which this reference collection editor should search for.Returns the root type of this reference collection editor i.e.Returns the flag that indicates whether reference selector can create new item.voidsetAllowCreate(Boolean allowCreate) Sets the flag that indicates whether reference selector can create new item.voidsetRootSearchType(ObjectType rootSearchType) Sets the type for which this reference selector should search for.voidsetRootType(ObjectType rootType) Sets the root type of this reference editor i.e.Methods inherited from interface de.hybris.platform.cockpit.model.editor.UIEditor
createViewComponent, getEditorType, getValue, isEditable, isInline, isOptional, setEditable, setFocus, setOptional, setValue
-
Field Details
-
ALLOW_CREATE_PARAM_KEY
- See Also:
-
-
Method Details
-
setRootType
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
Sets the type for which this reference selector should search for. Note: Generally, ifrootSearchTypeisnull, the set root type will be used.- See Also:
-
getRootType
ObjectType getRootType()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 bygetRootSearchType(). In this case information about the root type is generally needed for value handling.- Returns:
- the root type of this editor
- See Also:
-
getRootSearchType
ObjectType getRootSearchType()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 asgetRootType(). 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:
-
isAllowCreate
Boolean isAllowCreate()Returns the flag that indicates whether reference selector can create new item.- Returns:
- the flag
-
setAllowCreate
Sets the flag that indicates whether reference selector can create new item.
-