Class ListViewCollectionEditor

All Implemented Interfaces:
ReferenceUIEditor, UIEditor

public class ListViewCollectionEditor extends AbstractReferenceUIEditor
  • Field Details

  • Constructor Details

    • ListViewCollectionEditor

      public ListViewCollectionEditor()
    • ListViewCollectionEditor

      public ListViewCollectionEditor(ObjectType rootType)
  • Method Details

    • createViewComponent

      public org.zkoss.zk.ui.HtmlBasedComponent createViewComponent(Object initialValue, Map<String,? extends Object> parameters, EditorListener listener)
      Description copied from interface: UIEditor
      Creates a new editor component and attaches it to the specified Page page.
      Parameters:
      initialValue - editor's initial value
      parameters - parameters passed via configuration for particular editor
      listener - the EditorListener that will receive events when the editor's value is changed
      Returns:
      the editor component
    • getRootSearchType

      public ObjectType getRootSearchType()
      Description copied from interface: ReferenceUIEditor
      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 ReferenceUIEditor.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

      public ObjectType getRootType()
      Description copied from interface: ReferenceUIEditor
      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 ReferenceUIEditor.getRootSearchType(). In this case information about the root type is generally needed for value handling.

      Returns:
      the root type of this editor
      See Also:
    • createViewComponent

      protected ListSectionComponent createViewComponent(ListSectionModel model)
    • setAllowCreate

      public void setAllowCreate(Boolean allowCreate)
      Description copied from interface: ReferenceUIEditor
      Sets the flag that indicates whether reference selector can create new item.

      Specified by:
      setAllowCreate in interface ReferenceUIEditor
      Overrides:
      setAllowCreate in class AbstractReferenceUIEditor
    • setRootSearchType

      public void setRootSearchType(ObjectType rootSearchType)
      Description copied from interface: ReferenceUIEditor
      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

      public void setRootType(ObjectType rootType)
      Description copied from interface: ReferenceUIEditor
      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
    • getModel

      protected ListSectionModel getModel()
    • isInline

      public boolean isInline()
      Description copied from interface: UIEditor
      Returns whether this editor is an inline editor or not.
      Returns:
      true, if inline