Package com.inductiveautomation.ignition.designer.mvvm.binders.swing

Class BinderContext

java.lang.Object

com.inductiveautomation.ignition.designer.mvvm.binders.swing.BinderContext

All Implemented Interfaces:

Disposable, Consumer<Flow.Subscription>

public class BinderContext
extends Object
implements Consumer<Flow.Subscription>, Disposable

Contains references to subscriptions and EventListeners for usage in conjunction with the mvvm binder classes. For a given component, all the subscriptions and bindings associated with a particular binding is stored here, so that subscriptions and listeners can be added and removed when needed.

As an example for clarification: TextComponentBinders which binds JTextField, when bound to JTextComponent.setText(String) may store subscriptions to the PropertyPublisher (String) in this class, and the associated DocumentListener also.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BinderContext.UnregisterHandler

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BINDER_KEY

Constructor Summary

Constructors

Constructor	Description
BinderContext()

Method Summary

Modifier and Type	Method	Description
void	accept(Flow.Subscription subscription)
void	addComponent(Component component)	This method is used to add a component to the list of components that are used in bindings.
void	addDisposable(Disposable disposable)
void	addHandler(BinderContext.UnregisterHandler handler)
void	addListener(EventListener listener)
void	dispose()
static void	dispose(ClientPropertyAware source)
static void	disposeAndClean(JComponent component)	Disposes the BinderContext and calls the Container.removeAll() method on the component.
static BinderContext	getIfAbsentCreateThenAddComponent(ClientPropertyAware source)
static BinderContext	getIfAbsentCreateThenAddComponent(JComponent component)
Set<EventListener>	getListeners()
void	removeComponent(Component component)
void	removeHandler(BinderContext.UnregisterHandler handler)
void	removeListener(TableModelListener listener)
void	unregisterListeners()
void	unsubscribe()
static void	unsubscribe(JComponent component, String key)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Field Details

BINDER_KEY

public static final String BINDER_KEY

See Also:

• Constant Field Values

Constructor Details

BinderContext

public BinderContext()

Method Details

unsubscribe

public void unsubscribe()

accept

public void accept(Flow.Subscription subscription)

Specified by:

accept in interface Consumer<Flow.Subscription>

addListener

public void addListener(EventListener listener)

removeListener

public void removeListener(TableModelListener listener)

getListeners

public Set<EventListener> getListeners()

addComponent

public void addComponent(Component component)

This method is used to add a component to the list of components that are used in bindings.

removeComponent

public void removeComponent(Component component)

unregisterListeners

public void unregisterListeners()

addDisposable

public void addDisposable(Disposable disposable)

addHandler

public void addHandler(BinderContext.UnregisterHandler handler)

removeHandler

public void removeHandler(BinderContext.UnregisterHandler handler)

dispose

public void dispose()

Specified by:

dispose in interface Disposable

getIfAbsentCreateThenAddComponent

public static BinderContext getIfAbsentCreateThenAddComponent(JComponent component)

getIfAbsentCreateThenAddComponent

public static BinderContext getIfAbsentCreateThenAddComponent(ClientPropertyAware source)

unsubscribe

public static void unsubscribe(JComponent component,
 String key)

dispose

public static void dispose(ClientPropertyAware source)

disposeAndClean

public static void disposeAndClean(JComponent component)

Disposes the BinderContext and calls the Container.removeAll() method on the component.

Parameters:

component - The component which is to be disposed and cleaned.