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

public interface ReferenceUIEditor extends UIEditor
Reference editor interface.
  • Field Details

  • Method Details

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

      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:
    • isAllowCreate

      Boolean isAllowCreate()
      Returns the flag that indicates whether reference selector can create new item.

      Returns:
      the flag
    • setAllowCreate

      void setAllowCreate(Boolean allowCreate)
      Sets the flag that indicates whether reference selector can create new item.