BinderCtrl (ZK Bind 9.5.0.1 API)

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

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTIVATOR`
`static String`	`BINDCTX`
`static String`	`BINDER`
`static String`	`BINDING`
`static String`	`BINDRENDERING`
`static String`	`CHILDREN_ATTR`
`static String`	`CHILDREN_BINDING_MODEL`
`static String`	`CHILDREN_BINDING_MODEL_LISTENER`
`static String`	`CHILDREN_BINDING_RENDERED_COMPONENTS`
`static String`	`CLIENT_INFO`
`static String`	`CLIENT_UPLOAD_INFO`
`static String`	`DEFAULT_QUEUE_NAME` Default queue name of a binder to share the bean notification and global commands
`static String`	`DEFAULT_QUEUE_SCOPE` Default queue scope of a binder to share the bean notification and global commands
`static String`	`DEPENDS_ON_COMP`
`static String`	`FORM_ID`
`static String`	`IGNORE_REF_VALUE`
`static String`	`IGNORE_TRACKER`
`static String`	`INVALIDATE_REF_VALUE`
`static String`	`IS_TEMPLATE_MODEL_ENABLED_ATTR`
`static String`	`LOAD_FORM_COMPONENT`
`static String`	`LOAD_FORM_EXPRESSION`
`static String`	`MATCHMEDIAVALUE_PREFIX`
`static String`	`MODEL`
`static String`	`NOTIFYS`
`static String`	`ON_BIND_CLEAN`
`static String`	`ON_BIND_INIT`
`static String`	`PHASE_LISTENER_CLASS_KEY` PhaseListener key
`static String`	`REMOVE_BINDINGS`
`static String`	`RENDERER_INSTALLED`
`static String`	`SAVE_BASE`
`static String`	`SRCPATH`
`static String`	`VALIDATES`
`static String`	`VAR`
`static String`	`VIEWMODELID_BINDER_MAP_KEY` Key of the relation from viewmodel id to binder
`static String`	`VM`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addFormAssociatedSaveBinding(org.zkoss.zk.ui.Component associatedComp, String formId, SaveBinding saveBinding, 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
`void`	`addPhaseListener(PhaseListener listener)` Add the `PhaseListener`
`void`	`addSaveFormFieldName(Form form, Set<String> fieldNames)` Adds all field names for saving with the given Form.
`void`	`addSaveFormFieldName(Form form, String fieldName)` Adds a field name for saving with the given Form.
`BindingAnnotationInfoChecker`	`getBindingAnnotationInfoChecker()` get binding annotation info checker
`BindingExecutionInfoCollector`	`getBindingExecutionInfoCollector()` get binding execution info collector
`Form`	`getForm(org.zkoss.zk.ui.Component comp, String id)` Get the form of the component
`Set<SaveBinding>`	`getFormAssociatedSaveBindings(org.zkoss.zk.ui.Component formComp)` Get associated save bindings of a form in a component
`List<Binding>`	`getLoadPromptBindings(org.zkoss.zk.ui.Component comp, String attr)` get all load prompt binding of the component and attribute
`Map<String,Method>`	`getMatchMediaValue()` Returns an unmodifiable Map containing all the MatchMedia annotation values of this binder.
`PhaseListener`	`getPhaseListener()` Deprecated. As of release ZK 8.0.0, please use `getPhaseListeners()` instead.
`List<PhaseListener>`	`getPhaseListeners()` get the first `PhaseListener`
`String`	`getQueueName()` Returns the queue name of this binder
`String`	`getQueueScope()` Returns the queue scope of this binder
`Set<String>`	`getSaveFormFieldNames(Form self)` Returns all field names for saving with the given Form.
`TemplateResolver`	`getTemplateResolver(org.zkoss.zk.ui.Component comp, String attr)` get the template resolver that sets by `Binder.setTemplate(Component, String, String, java.util.Map)`
`Tracker`	`getTracker()` Returns associated dependency tracker of this binder.
`ValidationMessages`	`getValidationMessages()` Get the `ValidationMessages`
`boolean`	`hasValidator(org.zkoss.zk.ui.Component comp, String attr)` is there a validator on the attribute of component
`boolean`	`isActivating()` check if binder is in activating state
`Set<String>`	`removeSaveFormFieldNames(Form self)` Remove all field names for saving with the given Form.
`void`	`setPhaseListener(PhaseListener listener)` Deprecated. As of release ZK 8.0.0, please use `addPhaseListener(PhaseListener)` instead.
`void`	`setValidationMessages(ValidationMessages messages)` Set the `ValidationMessages`
`void`	`storeForm(org.zkoss.zk.ui.Component comp, String id, Form form)` Store the form in the component with id

- Field Detail
  - DEFAULT_QUEUE_NAME
```
static final String DEFAULT_QUEUE_NAME
```
    Default queue name of a binder to share the bean notification and global commands
    
    See Also:
    
    Constant Field Values
  - DEFAULT_QUEUE_SCOPE
```
static final String DEFAULT_QUEUE_SCOPE
```
    Default queue scope of a binder to share the bean notification and global commands
    
    See Also:
    
    Constant Field Values
  - PHASE_LISTENER_CLASS_KEY
```
static final String PHASE_LISTENER_CLASS_KEY
```
    PhaseListener key
    
    See Also:
    
    Constant Field Values
  - VIEWMODELID_BINDER_MAP_KEY
```
static final String VIEWMODELID_BINDER_MAP_KEY
```
    Key of the relation from viewmodel id to binder
    
    See Also:
    
    Constant Field Values
  - BINDING
```
static final String BINDING
```
    See Also:
    
    Constant Field Values
  - BINDER
```
static final String BINDER
```
    See Also:
    
    Constant Field Values
  - BINDCTX
```
static final String BINDCTX
```
    See Also:
    
    Constant Field Values
  - VAR
```
static final String VAR
```
    See Also:
    
    Constant Field Values
  - VM
```
static final String VM
```
    See Also:
    
    Constant Field Values
  - NOTIFYS
```
static final String NOTIFYS
```
    See Also:
    
    Constant Field Values
  - VALIDATES
```
static final String VALIDATES
```
    See Also:
    
    Constant Field Values
  - SRCPATH
```
static final String SRCPATH
```
    See Also:
    
    Constant Field Values
  - DEPENDS_ON_COMP
```
static final String DEPENDS_ON_COMP
```
    See Also:
    
    Constant Field Values
  - RENDERER_INSTALLED
```
static final String RENDERER_INSTALLED
```
    See Also:
    
    Constant Field Values
  - REMOVE_BINDINGS
```
static final String REMOVE_BINDINGS
```
    See Also:
    
    Constant Field Values
  - IS_TEMPLATE_MODEL_ENABLED_ATTR
```
static final String IS_TEMPLATE_MODEL_ENABLED_ATTR
```
    See Also:
    
    Constant Field Values
  - LOAD_FORM_EXPRESSION
```
static final String LOAD_FORM_EXPRESSION
```
    See Also:
    
    Constant Field Values
  - LOAD_FORM_COMPONENT
```
static final String LOAD_FORM_COMPONENT
```
    See Also:
    
    Constant Field Values
  - IGNORE_TRACKER
```
static final String IGNORE_TRACKER
```
    See Also:
    
    Constant Field Values
  - IGNORE_REF_VALUE
```
static final String IGNORE_REF_VALUE
```
    See Also:
    
    Constant Field Values
  - INVALIDATE_REF_VALUE
```
static final String INVALIDATE_REF_VALUE
```
    See Also:
    
    Constant Field Values
  - SAVE_BASE
```
static final String SAVE_BASE
```
    See Also:
    
    Constant Field Values
  - ON_BIND_INIT
```
static final String ON_BIND_INIT
```
    See Also:
    
    Constant Field Values
  - ON_BIND_CLEAN
```
static final String ON_BIND_CLEAN
```
    See Also:
    
    Constant Field Values
  - MODEL
```
static final String MODEL
```
    See Also:
    
    Constant Field Values
  - FORM_ID
```
static final String FORM_ID
```
    See Also:
    
    Constant Field Values
  - CHILDREN_ATTR
```
static final String CHILDREN_ATTR
```
    See Also:
    
    Constant Field Values
  - ACTIVATOR
```
static final String ACTIVATOR
```
    See Also:
    
    Constant Field Values
  - BINDRENDERING
```
static final String BINDRENDERING
```
    See Also:
    
    Constant Field Values
  - CHILDREN_BINDING_RENDERED_COMPONENTS
```
static final String CHILDREN_BINDING_RENDERED_COMPONENTS
```
    See Also:
    
    Constant Field Values
  - CHILDREN_BINDING_MODEL
```
static final String CHILDREN_BINDING_MODEL
```
    See Also:
    
    Constant Field Values
  - CHILDREN_BINDING_MODEL_LISTENER
```
static final String CHILDREN_BINDING_MODEL_LISTENER
```
    See Also:
    
    Constant Field Values
  - CLIENT_INFO
```
static final String CLIENT_INFO
```
    See Also:
    
    Constant Field Values
  - MATCHMEDIAVALUE_PREFIX
```
static final String MATCHMEDIAVALUE_PREFIX
```
    See Also:
    
    Constant Field Values
  - CLIENT_UPLOAD_INFO
```
static final String CLIENT_UPLOAD_INFO
```
    See Also:
    
    Constant Field Values
- Method Detail
  - addFormAssociatedSaveBinding
```
void addFormAssociatedSaveBinding(org.zkoss.zk.ui.Component associatedComp,
                                  String formId,
                                  SaveBinding saveBinding,
                                  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
```
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,
               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,
             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.
  - getValidationMessages
```
ValidationMessages getValidationMessages()
```
    Get the ValidationMessages
    
    Returns:
    
    null if no one set the instance by setValidationMessages(ValidationMessages)
  - setValidationMessages
```
void setValidationMessages(ValidationMessages messages)
```
    Set the ValidationMessages
    
    Parameters:
    
    messages - the ValidationMessages
  - hasValidator
```
boolean hasValidator(org.zkoss.zk.ui.Component comp,
                     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
  - getTemplateResolver
```
TemplateResolver getTemplateResolver(org.zkoss.zk.ui.Component comp,
                                     String attr)
```
    get the template resolver that sets by Binder.setTemplate(Component, String, String, java.util.Map)
    
    Parameters:
    
    comp - the component has resolvers
    
    attr - the attribute to get the resolver
    
    Returns:
    
    the resolver, null if not existed.
  - getLoadPromptBindings
```
List<Binding> getLoadPromptBindings(org.zkoss.zk.ui.Component comp,
                                    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
  - getPhaseListener
```
PhaseListener getPhaseListener()
```
    Deprecated. As of release ZK 8.0.0, please use getPhaseListeners() instead.
    
    get the first PhaseListener
    
    Returns:
    
    the PhaseListener
  - getPhaseListeners
```
List<PhaseListener> getPhaseListeners()
```
    get the first PhaseListener
    
    Returns:
    
    the PhaseListener
  - setPhaseListener
```
void setPhaseListener(PhaseListener listener)
```
    Deprecated. As of release ZK 8.0.0, please use addPhaseListener(PhaseListener) instead.
    
    set the PhaseListener
    
    Parameters:
    
    listener - the PhaseListener
  - addPhaseListener
```
void addPhaseListener(PhaseListener listener)
```
    Add the PhaseListener
    
    Parameters:
    
    listener -
    
    Since:
    
    8.0.0
  - isActivating
```
boolean isActivating()
```
    check if binder is in activating state
    
    Returns:
    
    true if binder is currently in activating state
    
    Since:
    
    6.0.1
  - 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
```
String getQueueName()
```
    Returns the queue name of this binder
    
    Since:
    
    8.0.0
  - getQueueScope
```
String getQueueScope()
```
    Returns the queue scope of this binder
    
    Since:
    
    8.0.0
  - addSaveFormFieldName
```
void addSaveFormFieldName(Form form,
                          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,
                          Set<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
```
Set<String> getSaveFormFieldNames(Form self)
```
    Returns all field names for saving with the given Form.
    
    Since:
    
    8.0.0
  - removeSaveFormFieldNames
```
Set<String> removeSaveFormFieldNames(Form self)
```
    Remove all field names for saving with the given Form.
    
    Since:
    
    8.0.0
  - getMatchMediaValue
```
Map<String,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

Interface BinderCtrl

Field Summary

Method Summary

Field Detail

DEFAULT_QUEUE_NAME

DEFAULT_QUEUE_SCOPE

PHASE_LISTENER_CLASS_KEY

VIEWMODELID_BINDER_MAP_KEY

BINDING

BINDER

BINDCTX

VAR

VM

NOTIFYS

VALIDATES

SRCPATH

DEPENDS_ON_COMP

RENDERER_INSTALLED

REMOVE_BINDINGS

IS_TEMPLATE_MODEL_ENABLED_ATTR

LOAD_FORM_EXPRESSION

LOAD_FORM_COMPONENT

IGNORE_TRACKER

IGNORE_REF_VALUE

INVALIDATE_REF_VALUE

SAVE_BASE

ON_BIND_INIT

ON_BIND_CLEAN

MODEL

FORM_ID

CHILDREN_ATTR

ACTIVATOR

BINDRENDERING

CHILDREN_BINDING_RENDERED_COMPONENTS

CHILDREN_BINDING_MODEL

CHILDREN_BINDING_MODEL_LISTENER

CLIENT_INFO

MATCHMEDIAVALUE_PREFIX

CLIENT_UPLOAD_INFO

Method Detail

addFormAssociatedSaveBinding

getFormAssociatedSaveBindings

storeForm

getForm

getTracker

getValidationMessages

setValidationMessages

hasValidator

getTemplateResolver

getLoadPromptBindings

getPhaseListener

getPhaseListeners

setPhaseListener

addPhaseListener

isActivating

getBindingExecutionInfoCollector

getBindingAnnotationInfoChecker

getQueueName

getQueueScope

addSaveFormFieldName

addSaveFormFieldName

getSaveFormFieldNames

removeSaveFormFieldNames

getMatchMediaValue