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

Field Summary
static java.lang.String DEFAULT_QUEUE_NAME
          Default queue name of a binder to share the bean notification and global commands
static java.lang.String DEFAULT_QUEUE_SCOPE
          Default queue scope of a binder to share the bean notification and global commands
static java.lang.String PHASE_LISTENER_CLASS_KEY
          PhaseListener key
 
Method Summary
 void addFormAssociatedSaveBinding(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
 BindingAnnotationInfoChecker getBindingAnnotationInfoChecker()
          get binding annotation info checker
 BindingExecutionInfoCollector getBindingExecutionInfoCollector()
          get binding execution info collector
 Form getForm(Component comp, java.lang.String id)
          Get the form of the component
 java.util.Set<SaveBinding> getFormAssociatedSaveBindings(Component formComp)
          Get associated save bindings of a form in a component
 java.util.List<Binding> getLoadPromptBindings(Component comp, java.lang.String attr)
          get all load prompt binding of the component and attribute
 PhaseListener getPhaseListener()
          get the PhaseListener
 TemplateResolver getTemplateResolver(Component comp, java.lang.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(Component comp, java.lang.String attr)
          is there a validator on the attribute of component
 boolean isActivating()
          check if binder is in activating state
 void setPhaseListener(PhaseListener listener)
          set the PhaseListener
 void setValidationMessages(ValidationMessages messages)
          Set the ValidationMessages
 void storeForm(Component comp, java.lang.String id, Form form)
          Store the form in the component with id
 

Field Detail

DEFAULT_QUEUE_NAME

static final java.lang.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 java.lang.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 java.lang.String PHASE_LISTENER_CLASS_KEY
PhaseListener key

See Also:
Constant Field Values
Method Detail

addFormAssociatedSaveBinding

void addFormAssociatedSaveBinding(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(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(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(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.

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(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

getTemplateResolver

TemplateResolver getTemplateResolver(Component comp,
                                     java.lang.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

java.util.List<Binding> getLoadPromptBindings(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

getPhaseListener

PhaseListener getPhaseListener()
get the PhaseListener

Returns:
the PhaseListener

setPhaseListener

void setPhaseListener(PhaseListener listener)
set the PhaseListener

Parameters:
listener - the PhaseListener

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


Copyright © 2005-2011 Potix Corporation. All Rights Reserved. SourceForge.net Logo