org.tentackle.swing.bind

Interface FormComponentBinder

All Superinterfaces:

Binder, Comparable<Binder>

All Known Implementing Classes:

DefaultFormComponentBinder

public interface FormComponentBinder
extends Binder

The Binder that associates form components with object binding paths.

Author:

harald

Method Summary

Modifier and Type	Method and Description
int	bindWithInheritedBindables() Binds with bindable inheritance.
int	bindWithInheritedComponents() Binds with form inheritance.
FormComponentBinding	getBinding(FormComponent component) Gets a binding by component.
FormComponentBinding	getBinding(String bindingPath)
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.
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().

Methods inherited from interface org.tentackle.bind.Binder

addBinding, addToModelListener, addToViewListener, addValidationListener, assertAllBound, bind, bindAllInherited, fireToModel, fireToView, fireValidated, getBindingProperty, getBindingProperty, getBindings, getInstanceNumber, getToModelListeners, getToViewListeners, getValidationListeners, getValidationScope, putBindingProperty, removeToModelListener, removeToViewListener, removeValidationListener, setValidationScope, unbind

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getFormContainer

FormContainer getFormContainer()

Gets the container bound by this binder.

Returns:

the form

bindWithInheritedComponents

int bindWithInheritedComponents()

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!

Returns:

number of members bound

bindWithInheritedBindables

int bindWithInheritedBindables()

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!

Returns:

number of members bound

getBinding

FormComponentBinding getBinding(FormComponent component)

Gets a binding by component.

Parameters:

component - the component assigned to the binding

Returns:

the binding, null if component not bound

getBinding

FormComponentBinding getBinding(String bindingPath)

Overridden to cast.

Specified by:

getBinding in interface Binder

getBoundComponents

Collection<FormComponent> getBoundComponents()

Gets the list of all bound components of this form.

Returns:

the list of bound components, never null

getUnboundComponents

Collection<FormComponent> getUnboundComponents()

Gets the list of all unbound components of this form.

Returns:

the list of unbound components, never null

removeBinding

FormComponentBinding removeBinding(FormComponent component)

Programmatically removes a binding from this form.

Parameters:

component - the component assigned to the binding

Returns:

the removed binding, null if no such binding found

removeBinding

FormComponentBinding removeBinding(String bindingPath)

Overridden to cast.

Specified by:

removeBinding in interface Binder

getMandatoryBindings

List<? extends Binding> getMandatoryBindings()

Gets the dynamically mandatory bindings.

Returns:

the mandatory bindings

requestMandatoryUpdate

void requestMandatoryUpdate()

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

getChangeableBindings

List<? extends Binding> getChangeableBindings()

Gets the dynamically changeable bindings.

Returns:

the changaeble bindings

requestChangeableUpdate

void requestChangeableUpdate()

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