Class SimpleReferenceUIEditor

    • Constructor Detail

      • SimpleReferenceUIEditor

        public SimpleReferenceUIEditor()
    • Method Detail

      • updateAvailableValues

        @Deprecated
        protected boolean updateAvailableValues()
        Deprecated.
        since 6.3, use updateAvailableValues(Map) instead.
      • updateAvailableValues

        protected boolean updateAvailableValues​(java.util.Map<java.lang.String,​? extends java.lang.Object> parameters)
      • setAvailableValues

        public void setAvailableValues​(java.util.List<TypedObject> availableValues)
      • getAvailableValues

        protected java.util.List<TypedObject> getAvailableValues()
      • fillComboBox

        protected void fillComboBox​(org.zkoss.zul.Combobox combobox,
                                    TypedObject selected)
      • parseParams

        protected void parseParams​(java.util.Map<java.lang.String,​? extends java.lang.Object> parameters)
      • createViewComponent

        public org.zkoss.zk.ui.HtmlBasedComponent createViewComponent​(java.lang.Object initialValue,
                                                                      java.util.Map<java.lang.String,​? extends java.lang.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:
        ReferenceUIEditor.getRootType()
      • 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:
        ReferenceUIEditor.getRootSearchType()
      • 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
      • isInline

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

        protected TypeService getTypeService()