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

Interface ReferenceUIEditor

All Superinterfaces:

UIEditor

All Known Implementing Classes:

AbstractReferenceUIEditor, CelumMediaCollectionUIEditor, CelumMediaReferenceCollectionUIEditor, CelumMediaReferenceUIEditor, CelumSimpleMediaReferenceUIEditor, CollectionUIEditor, CollectionUIEditorMedia, ContextAreaReferenceCollectionUIEditor, DefaultMediaReferenceCollectionUIEditor, DefaultMediaReferenceUIEditor, DefaultReferenceCollectionUIEditor, DefaultReferenceUIEditor, DefaultSimpleMediaReferenceUIEditor, DefaultSimpleReferenceUIEditor, ListViewCollectionEditor, MinimalReferenceUIEditor, SimpleReferenceUIEditor, UnitReferenceUIEditor

public interface ReferenceUIEditor
extends UIEditor

Reference editor interface.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ALLOW_CREATE_PARAM_KEY

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

INITIAL_EDIT_STRING

Method Summary

Modifier and Type	Method	Description
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.
java.lang.Boolean	isAllowCreate()	Returns the flag that indicates whether reference selector can create new item.
void	setAllowCreate(java.lang.Boolean allowCreate)	Sets the flag that indicates whether reference selector can create new item.
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.

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

createViewComponent, getEditorType, getValue, isEditable, isInline, isOptional, setEditable, setFocus, setOptional, setValue

Field Detail

ALLOW_CREATE_PARAM_KEY

static final java.lang.String ALLOW_CREATE_PARAM_KEY

See Also:

Constant Field Values

Method Detail

setRootType

void setRootType(ObjectType rootType)

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

void setRootSearchType(ObjectType rootSearchType)

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:

setRootType(ObjectType)

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 by getRootSearchType(). In this case information about the root type is generally needed for value handling.

Returns:

the root type of this editor

See Also:

getRootSearchType()

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 as 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:

getRootType()

isAllowCreate

java.lang.Boolean isAllowCreate()

Returns the flag that indicates whether reference selector can create new item.

Returns:

the flag

setAllowCreate

void setAllowCreate(java.lang.Boolean allowCreate)

Sets the flag that indicates whether reference selector can create new item.