Package org.zkoss.bind.sys

Interface BinderCtrl

  • All Known Implementing Classes:
    AnnotateBinder, BinderImpl, DefaultBinder
    public interface BinderCtrl
    An addition interface to Binder that is used for implementation or tools.

    Application developers rarely need to access methods in this interface.
    Since:
    6.0.0
    Author:
    dennis, jumperchen

    • Method Detail

      • addFormAssociatedSaveBinding

        void addFormAssociatedSaveBinding​(org.zkoss.zk.ui.Component associatedComp,
                                  java.lang.String formId,
                                  SaveBinding saveBinding,
                                  java.lang.String fieldName)
        Add a association between formId and a associated save binding(save binding inside a form), the form has to exist in the parent components
        Parameters:
        associatedComp - associated component inside a form binding
        formId - the form id
        saveBinding - the nested save binding in side a form binding
        fieldName - the associated form fieldName for the associated save binding
        Since:
        6.0.1

      • getFormAssociatedSaveBindings

        java.util.Set<SaveBinding> getFormAssociatedSaveBindings​(org.zkoss.zk.ui.Component formComp)
        Get associated save bindings of a form in a component
        Parameters:
        formComp - the component that contains the form
        Returns:
        all associated save binding in the form

      • storeForm

        void storeForm​(org.zkoss.zk.ui.Component comp,
               java.lang.String id,
               Form form)
        Store the form in the component with id
        Parameters:
        comp - the component to store the form
        id - the form id
        form - the form instance

      • getForm

        Form getForm​(org.zkoss.zk.ui.Component comp,
             java.lang.String id)
        Get the form of the component
        Parameters:
        comp - the component has the form
        id - the form id
        Returns:
        the form if there is a form inside the component with the id

      • getTracker

        Tracker getTracker()
        Returns associated dependency tracker of this binder.
        Returns:
        associated dependency tracker of this binder.

      • hasValidator

        boolean hasValidator​(org.zkoss.zk.ui.Component comp,
                     java.lang.String attr)
        is there a validator on the attribute of component
        Parameters:
        comp - the component to check
        attr - the attribute to check
        Returns:
        true if there is a validator

      • getLoadPromptBindings

        java.util.List<Binding> getLoadPromptBindings​(org.zkoss.zk.ui.Component comp,
                                              java.lang.String attr)
        get all load prompt binding of the component and attribute
        Parameters:
        comp - the component is relative to the bindings
        attr - the attribute is relative to the bindings
        Returns:
        the prompt-load-bindings

      • isActivating

        boolean isActivating()
        check if binder is in activating state
        Returns:
        true if binder is currently in activating state
        Since:
        6.0.1

      • initQueue

        void initQueue()
        Internal use only. Check and init queue
        Since:
        10.0.0

      • initActivator

        void initActivator()
        Internal use only. Check and init Activator
        Since:
        10.0.0

      • getBindingExecutionInfoCollector

        BindingExecutionInfoCollector getBindingExecutionInfoCollector()
        get binding execution info collector
        Returns:
        the collector instance or null if no collector is existed
        Since:
        6.5.2

      • getBindingAnnotationInfoChecker

        BindingAnnotationInfoChecker getBindingAnnotationInfoChecker()
        get binding annotation info checker
        Returns:
        the collector instance or null if no collector is existed
        Since:
        6.5.2

      • getQueueName

        java.lang.String getQueueName()
        Returns the queue name of this binder
        Since:
        8.0.0

      • getQueueScope

        java.lang.String getQueueScope()
        Returns the queue scope of this binder
        Since:
        8.0.0

      • addSaveFormFieldName

        void addSaveFormFieldName​(Form form,
                          java.lang.String fieldName)
        Adds a field name for saving with the given Form.
        Parameters:
        fieldName - field name to be saved into.
        Since:
        8.0.0

      • addSaveFormFieldName

        void addSaveFormFieldName​(Form form,
                          java.util.Set<java.lang.String> fieldNames)
        Adds all field names for saving with the given Form.
        Parameters:
        fieldNames - field name to be saved into.
        Since:
        8.0.0

      • getSaveFormFieldNames

        java.util.Set<java.lang.String> getSaveFormFieldNames​(Form self)
        Returns all field names for saving with the given Form.
        Since:
        8.0.0

      • removeSaveFormFieldNames

        java.util.Set<java.lang.String> removeSaveFormFieldNames​(Form self)
        Remove all field names for saving with the given Form.
        Since:
        8.0.0

      • getMatchMediaValue

        java.util.Map<java.lang.String,​java.lang.reflect.Method> getMatchMediaValue()
        Returns an unmodifiable Map containing all the MatchMedia annotation values of this binder. If there's no MatchMedia annotation, it returns an empty Map.
        Since:
        8.0.2