Package com.github.stasgora.observetree

Class SettableObservable<T extends Observable>

java.lang.Object

io.github.stasgora.observetree.Observable

io.github.stasgora.observetree.SettableProperty<T>

com.github.stasgora.observetree.SettableObservable<T>

Type Parameters:

T - the type of the actual observable data type. Must extend from Observable

All Implemented Interfaces:

java.io.Serializable

public class SettableObservable<T extends Observable>
extends SettableProperty<T>

Extends the functionality of the SettableProperty for SettableProperty.modelValue extending Observable. Maintains a persistent set of SettableProperty.modelValue listeners that are copied over whenever a new SettableProperty.modelValue is set. Parents of this SettableProperty automatically become parents of it's SettableProperty.modelValue.

Author:

Stanisław Góra

See Also:

SettableProperty, Serialized Form

Field Summary

Fields inherited from class com.github.stasgora.observetree.SettableProperty

defaultValue, modelValue

Fields inherited from class com.github.stasgora.observetree.Observable

notificationMethod

Constructor Summary

Constructors

Constructor	Description
SettableObservable()	Constructs a new, empty SettableObservable with null SettableProperty.modelValue
SettableObservable(T modelValue)	Constructs a new SettableObservable with the specified SettableProperty.modelValue

Method Summary

Modifier and Type	Method	Description
protected boolean	addParent(Observable observable)	Sets the specified Observable as a parent of this SettableObservable.
boolean	addStaticListener(ChangeListener listener)	Adds the specified listener to the list of static listeners with the default priority ListenerPriority.NORMAL (0).
boolean	addStaticListener(ChangeListener listener, int priority)	Adds the specified listener to the list of static listeners with the specified priority.
boolean	addStaticListener(ChangeListener listener, ListenerPriority priority)	Adds the specified listener to the list of static listeners with the specified priority.
protected boolean	removeParent(Observable observable)	Removes the specified Observable from parents of this SettableObservable.
boolean	removeStaticListener(ChangeListener listener)	Removes the specified static listener from the list of listeners.
void	set(T modelValue)	Sets the SettableProperty.modelValue of this SettableObservable.

Methods inherited from class com.github.stasgora.observetree.SettableProperty

get, getDefaultValue, modify, present, resetToDefaultValue, saveAsDefaultValue, setAndNotify, setDefaultValue

Methods inherited from class com.github.stasgora.observetree.Observable

add, add, add, addChild, addListener, addListener, addListener, addSubObservable, clearListeners, copyListeners, getChildren, getParents, notifyListeners, onValueChanged, remove, removeChild, removeListener, removeSubObservable, setUnchanged

Methods inherited from class java.lang.Object

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

Constructor Detail

SettableObservable

public SettableObservable()

Constructs a new, empty SettableObservable with null SettableProperty.modelValue

SettableObservable

public SettableObservable(T modelValue)

Constructs a new SettableObservable with the specified SettableProperty.modelValue

Parameters:

modelValue - a value to be set

Method Detail

addStaticListener

public boolean addStaticListener(ChangeListener listener)

Adds the specified listener to the list of static listeners with the default priority ListenerPriority.NORMAL (0).

Parameters:

listener - element to be added

Returns:

true if the listener was successfully added. false if it was already present

addStaticListener

public boolean addStaticListener(ChangeListener listener,
                                 ListenerPriority priority)

Adds the specified listener to the list of static listeners with the specified priority.

Parameters:

listener - element to be added

priority - priority of this listener

Returns:

true if the listener was successfully added. false if it was already present

addStaticListener

public boolean addStaticListener(ChangeListener listener,
                                 int priority)

Adds the specified listener to the list of static listeners with the specified priority.

Parameters:

listener - element to be added

priority - priority of this listener

Returns:

true if the listener was successfully added. false if it was already present

removeStaticListener

public boolean removeStaticListener(ChangeListener listener)

Removes the specified static listener from the list of listeners.

Parameters:

listener - element to be removed

Returns:

true if the listener was successfully removed. false if it was not found

addParent

protected boolean addParent(Observable observable)

Sets the specified Observable as a parent of this SettableObservable. Note: this creates only one way binding. Observable.addSubObservable(Observable) method is recommended for setting up Observable relations. Method overridden to provide additional functionality.

Overrides:

addParent in class Observable

Parameters:

observable - parent to be added

Returns:

true if the Observable was successfully added. false if it was already present

removeParent

protected boolean removeParent(Observable observable)

Removes the specified Observable from parents of this SettableObservable. Note: this removed one way binding only. Observable.removeSubObservable(Observable) method is recommended for removing Observable relations. Method overridden to provide additional functionality.

Overrides:

removeParent in class Observable

Parameters:

observable - parent to be removed

Returns:

true if the Observable was successfully removed. false if it was not found

set

public void set(T modelValue)

Sets the SettableProperty.modelValue of this SettableObservable. Method overridden to provide additional functionality.

Overrides:

set in class SettableProperty<T extends Observable>

Parameters:

modelValue - value to be set