Module org.tentackle.fx

Package org.tentackle.fx.bind

Class DefaultFxComponentBinder

java.lang.Object

org.tentackle.bind.AbstractBinder

org.tentackle.fx.bind.DefaultFxComponentBinder

All Implemented Interfaces:

Comparable<Binder>, Binder, FxComponentBinder

public class DefaultFxComponentBinder
extends AbstractBinder
implements FxComponentBinder

Binding Workhorse.

Author:

harald

Field Summary

Fields

Modifier and Type	Field	Description
static String[]	bindingPathSuffixes	Suffixes of component names to provide binding path alternatives. Applications may change this list.

Constructor Summary

Constructors

Constructor	Description
DefaultFxComponentBinder(FxController controller)	Creates a binder for a controller.

Method Summary

Modifier and Type	Method	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 including inherited bindables.
int	bindWithInheritedComponents()	Binds including inherited components.
protected int	doBind(BindingMember[] parents, String parentMemberPath, Class<?> parentClass, boolean declaredOnly)
void	fireToModel(Binding binding, Object parent, Object viewValue)
void	fireToView(Binding binding, Object parent, Object modelValue)
FxComponentBinding	getBinding(String bindingPath)
FxComponentBinding	getBinding(FxComponent component)	Gets a binding by component.
Collection<FxComponentBinding>	getBindings()
Collection<FxComponent>	getBoundComponents()	Gets the list of all bound components of this form.
List<? extends Binding>	getChangeableBindings()	Gets the dynamically changeable bindings.
FxController	getController()	Gets the controller bound by this binder.
List<? extends Binding>	getMandatoryBindings()	Gets the dynamically mandatory bindings.
Collection<FxComponent>	getUnboundComponents()	Gets the list of all unbound components of this form.
boolean	isUnboundPending()	Checks whether some components are still unbound.
FxComponentBinding	removeBinding(String bindingPath)
FxComponentBinding	removeBinding(FxComponent component)	Programmatically removes a binding from this view.
void	requestChangeableUpdate()	Request to update the changeable attribute of all dynamically mandatory components.
void	requestMandatoryUpdate()	Request to update the mandatory attribute of all dynamically mandatory components.
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

Field Details

bindingPathSuffixes

public static String[] bindingPathSuffixes

Suffixes of component names to provide binding path alternatives.
Applications may change this list.

Constructor Details

DefaultFxComponentBinder

public DefaultFxComponentBinder(FxController controller)

Creates a binder for a controller.

Parameters:

controller - the controller to bind

Method Details

getController

public FxController getController()

Description copied from interface: FxComponentBinder

Gets the controller bound by this binder.

Specified by:

getController in interface FxComponentBinder

Returns:

the controller

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: FxComponentBinder

Request to update the mandatory attribute of all dynamically mandatory components.

Specified by:

requestMandatoryUpdate in interface FxComponentBinder

getMandatoryBindings

public List<? extends Binding> getMandatoryBindings()

Description copied from interface: FxComponentBinder

Gets the dynamically mandatory bindings.

Specified by:

getMandatoryBindings in interface FxComponentBinder

Returns:

the mandatory bindings

requestChangeableUpdate

public void requestChangeableUpdate()

Description copied from interface: FxComponentBinder

Request to update the changeable attribute of all dynamically mandatory components.

Specified by:

requestChangeableUpdate in interface FxComponentBinder

getChangeableBindings

public List<? extends Binding> getChangeableBindings()

Description copied from interface: FxComponentBinder

Gets the dynamically changeable bindings.

Specified by:

getChangeableBindings in interface FxComponentBinder

Returns:

the changeable bindings

bindAllInherited

public int bindAllInherited()

Specified by:

bindAllInherited in interface Binder

bindWithInheritedBindables

public int bindWithInheritedBindables()

Description copied from interface: FxComponentBinder

Binds including inherited bindables.

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

CAUTION: expensive operation!

Specified by:

bindWithInheritedBindables in interface FxComponentBinder

Returns:

number of members bound

bindWithInheritedComponents

public int bindWithInheritedComponents()

Description copied from interface: FxComponentBinder

Binds including inherited components.

The controller will be scanned for members or sub members annotated with the Bindable-annotation. Inherited components declared in parent controllers are included.

CAUTION: expensive operation!

Specified by:

bindWithInheritedComponents in interface FxComponentBinder

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<FxComponentBinding> getBindings()

Specified by:

getBindings in interface Binder

getBoundComponents

public Collection<FxComponent> getBoundComponents()

Description copied from interface: FxComponentBinder

Gets the list of all bound components of this form.

Specified by:

getBoundComponents in interface FxComponentBinder

Returns:

the list of bound components, never null

getUnboundComponents

public Collection<FxComponent> getUnboundComponents()

Description copied from interface: FxComponentBinder

Gets the list of all unbound components of this form.

Specified by:

getUnboundComponents in interface FxComponentBinder

Returns:

the list of unbound components, never null

isUnboundPending

public boolean isUnboundPending()

Checks whether some components are still unbound.

Returns:

true if unbound pending, false if all bound

assertAllBound

public void assertAllBound()

Specified by:

assertAllBound in interface Binder

addBinding

public void addBinding(Binding binding)

Specified by:

addBinding in interface Binder

getBinding

public FxComponentBinding getBinding(FxComponent component)

Description copied from interface: FxComponentBinder

Gets a binding by component.

Specified by:

getBinding in interface FxComponentBinder

Parameters:

component - the component assigned to the binding

Returns:

the binding, null if component not bound

getBinding

public FxComponentBinding getBinding(String bindingPath)

Description copied from interface: FxComponentBinder

Overridden to cast.

Specified by:

getBinding in interface Binder

Specified by:

getBinding in interface FxComponentBinder

removeBinding

public FxComponentBinding removeBinding(FxComponent component)

Description copied from interface: FxComponentBinder

Programmatically removes a binding from this view.

Specified by:

removeBinding in interface FxComponentBinder

Parameters:

component - the component assigned to the binding

Returns:

the removed binding, null if no such binding found

removeBinding

public FxComponentBinding removeBinding(String bindingPath)

Description copied from interface: FxComponentBinder

Overridden to cast.

Specified by:

removeBinding in interface Binder

Specified by:

removeBinding in interface FxComponentBinder

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)

Specified by:

doBind in class AbstractBinder