org.tentackle.swing.bind

Class DefaultFormComponentBinder

java.lang.Object

org.tentackle.bind.AbstractBinder

org.tentackle.swing.bind.DefaultFormComponentBinder

All Implemented Interfaces:

Comparable<Binder>, Binder, FormComponentBinder

public class DefaultFormComponentBinder
extends AbstractBinder
implements FormComponentBinder

Binding Workhorse.

Author:

harald

Constructor Summary

Constructors

Constructor and Description
DefaultFormComponentBinder(FormContainer form) Creates a binder for a form.

Method Summary

Modifier and Type	Method and Description
void	addBinding(Binding binding)
protected void	addChangeableBinding(Binding changeableBinding) Adds a changeable binding.
protected void	addMandatoryBinding(Binding mandatoryBinding) Adds a mandatory binding.
void	assertAllBound()
int	bind()
int	bindAllInherited()
int	bindWithInheritedBindables() Binds with bindable inheritance.
int	bindWithInheritedComponents() Binds with form inheritance.
protected int	doBind(BindingMember[] parents, String parentMemberPath, Class<?> parentClass, boolean declaredOnly) Binds an object to a form.
void	fireToModel(Binding binding, Object parent, Object viewValue)
void	fireToView(Binding binding, Object parent, Object modelValue)
FormComponentBinding	getBinding(FormComponent component) Gets a binding by component.
FormComponentBinding	getBinding(String bindingPath)
Collection<? extends Binding>	getBindings()
Collection<FormComponent>	getBoundComponents() Gets the list of all bound components of this form.
List<? extends Binding>	getChangeableBindings() Gets the dynamically changeable bindings.
FormContainer	getFormContainer() Gets the container bound by this binder.
List<? extends Binding>	getMandatoryBindings() Gets the dynamically mandatory bindings.
Collection<FormComponent>	getUnboundComponents() Gets the list of all unbound components of this form.
boolean	isUnboundPending() Checks whether some components are still unbound.
FormComponentBinding	removeBinding(FormComponent component) Programmatically removes a binding from this form.
FormComponentBinding	removeBinding(String bindingPath)
void	requestChangeableUpdate() Request to update the changeable attribute of all dynamically mandatory components. Used by FormContainer.setFormValues() and FormContainer.setFormValuesKeepChanged().
void	requestMandatoryUpdate() Request to update the mandatory attribute of all dynamically mandatory components. Used by FormContainer.setFormValues() and FormContainer.setFormValuesKeepChanged().
void	unbind()

Methods inherited from class org.tentackle.bind.AbstractBinder

addToModelListener, addToViewListener, addValidationListener, compareTo, equals, fireValidated, getBindingProperty, getBindingProperty, getInstanceNumber, getToModelListeners, getToViewListeners, getValidationListeners, getValidationScope, hashCode, putBindingProperty, removeToModelListener, removeToViewListener, removeValidationListener, setValidationScope

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.tentackle.bind.Binder

addToModelListener, addToViewListener, addValidationListener, fireValidated, getBindingProperty, getBindingProperty, getInstanceNumber, getToModelListeners, getToViewListeners, getValidationListeners, getValidationScope, putBindingProperty, removeToModelListener, removeToViewListener, removeValidationListener, setValidationScope

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

DefaultFormComponentBinder

public DefaultFormComponentBinder(FormContainer form)

Creates a binder for a form.

Parameters:

form - the form to bind

Method Detail

getFormContainer

public FormContainer getFormContainer()

Description copied from interface: FormComponentBinder

Gets the container bound by this binder.

Specified by:

getFormContainer in interface FormComponentBinder

Returns:

the form

fireToView

public void fireToView(Binding binding,
                       Object parent,
                       Object modelValue)
                throws BindingVetoException

Specified by:

fireToView in interface Binder

Overrides:

fireToView in class AbstractBinder

Throws:

BindingVetoException

fireToModel

public void fireToModel(Binding binding,
                        Object parent,
                        Object viewValue)
                 throws BindingVetoException

Specified by:

fireToModel in interface Binder

Overrides:

fireToModel in class AbstractBinder

Throws:

BindingVetoException

requestMandatoryUpdate

public void requestMandatoryUpdate()

Description copied from interface: FormComponentBinder

Request to update the mandatory attribute of all dynamically mandatory components.
Used by FormContainer.setFormValues() and FormContainer.setFormValuesKeepChanged().

Specified by:

requestMandatoryUpdate in interface FormComponentBinder

getMandatoryBindings

public List<? extends Binding> getMandatoryBindings()

Description copied from interface: FormComponentBinder

Gets the dynamically mandatory bindings.

Specified by:

getMandatoryBindings in interface FormComponentBinder

Returns:

the mandatory bindings

requestChangeableUpdate

public void requestChangeableUpdate()

Description copied from interface: FormComponentBinder

Request to update the changeable attribute of all dynamically mandatory components.
Used by FormContainer.setFormValues() and FormContainer.setFormValuesKeepChanged().

Specified by:

requestChangeableUpdate in interface FormComponentBinder

getChangeableBindings

public List<? extends Binding> getChangeableBindings()

Description copied from interface: FormComponentBinder

Gets the dynamically changeable bindings.

Specified by:

getChangeableBindings in interface FormComponentBinder

Returns:

the changaeble bindings

bindAllInherited

public int bindAllInherited()

Specified by:

bindAllInherited in interface Binder

bindWithInheritedBindables

public int bindWithInheritedBindables()

Description copied from interface: FormComponentBinder

Binds with bindable inheritance.

The form will be scanned for members or submembers annotated with the Bindable-annotation. Inherited members of all bindables will be included as well.

Notice that the object references are not kept in the binding.

CAUTION: expensive operation!

Specified by:

bindWithInheritedBindables in interface FormComponentBinder

Returns:

number of members bound

bindWithInheritedComponents

public int bindWithInheritedComponents()

Description copied from interface: FormComponentBinder

Binds with form inheritance.

The form will be scanned for members or submembers annotated with the Bindable-annotation. Inherited members of the form's parent classes will be included as well.

Notice that the object references are not kept in the binding.

CAUTION: expensive operation!

Specified by:

bindWithInheritedComponents in interface FormComponentBinder

Returns:

number of members bound

bind

public int bind()

Specified by:

bind in interface Binder

unbind

public void unbind()

Specified by:

unbind in interface Binder

getBindings

public Collection<? extends Binding> getBindings()

Specified by:

getBindings in interface Binder

getBoundComponents

public Collection<FormComponent> getBoundComponents()

Description copied from interface: FormComponentBinder

Gets the list of all bound components of this form.

Specified by:

getBoundComponents in interface FormComponentBinder

Returns:

the list of bound components, never null

isUnboundPending

public boolean isUnboundPending()

Checks whether some components are still unbound.

Returns:

true if unbound pending, false if all bound

getUnboundComponents

public Collection<FormComponent> getUnboundComponents()

Description copied from interface: FormComponentBinder

Gets the list of all unbound components of this form.

Specified by:

getUnboundComponents in interface FormComponentBinder

Returns:

the list of unbound components, never null

assertAllBound

public void assertAllBound()
                    throws BindingException

Specified by:

assertAllBound in interface Binder

Throws:

BindingException

addBinding

public void addBinding(Binding binding)

Specified by:

addBinding in interface Binder

getBinding

public FormComponentBinding getBinding(FormComponent component)

Description copied from interface: FormComponentBinder

Gets a binding by component.

Specified by:

getBinding in interface FormComponentBinder

Parameters:

component - the component assigned to the binding

Returns:

the binding, null if component not bound

getBinding

public FormComponentBinding getBinding(String bindingPath)

Description copied from interface: FormComponentBinder

Overridden to cast.

Specified by:

getBinding in interface Binder

Specified by:

getBinding in interface FormComponentBinder

removeBinding

public FormComponentBinding removeBinding(FormComponent component)

Description copied from interface: FormComponentBinder

Programmatically removes a binding from this form.

Specified by:

removeBinding in interface FormComponentBinder

Parameters:

component - the component assigned to the binding

Returns:

the removed binding, null if no such binding found

removeBinding

public FormComponentBinding removeBinding(String bindingPath)

Description copied from interface: FormComponentBinder

Overridden to cast.

Specified by:

removeBinding in interface Binder

Specified by:

removeBinding in interface FormComponentBinder

addMandatoryBinding

protected void addMandatoryBinding(Binding mandatoryBinding)

Adds a mandatory binding.

Parameters:

mandatoryBinding - the binding to add

addChangeableBinding

protected void addChangeableBinding(Binding changeableBinding)

Adds a changeable binding.

Parameters:

changeableBinding - the binding to add

doBind

protected int doBind(BindingMember[] parents,
                     String parentMemberPath,
                     Class<?> parentClass,
                     boolean declaredOnly)

Binds an object to a form.

The object will be scanned for members or submembers annotated with the Bindable-annotation and their corresponding setter- and getter methods.

More than one object can be bound to a form.

Notice that the object reference is not kept in the binding, i.e. the binding works only by declaration (reflection).

Specified by:

doBind in class AbstractBinder

Parameters:

parents - the fields building the declaration chain to this field, null if container

parentMemberPath - the object path prefix, null if root

parentClass - the object's class

declaredOnly - true if search for methods and field which are declared only, false to include inherited as well

Returns:

number of members bound