javafx.beans.property.adapter

Class ReadOnlyJavaBeanBooleanProperty

java.lang.Object

javafx.beans.binding.BooleanExpression

javafx.beans.property.ReadOnlyBooleanProperty

javafx.beans.property.ReadOnlyBooleanPropertyBase

javafx.beans.property.adapter.ReadOnlyJavaBeanBooleanProperty

All Implemented Interfaces:

Observable, ReadOnlyJavaBeanProperty<Boolean>, ReadOnlyProperty<Boolean>, ObservableBooleanValue, ObservableValue<Boolean>

public final class ReadOnlyJavaBeanBooleanProperty
extends ReadOnlyBooleanPropertyBase
implements ReadOnlyJavaBeanProperty<Boolean>

A ReadOnlyJavaBeanBooleanProperty provides an adapter between a regular read only Java Bean property of type boolean or Boolean and a JavaFX ReadOnlyBooleanProperty. It cannot be created directly, but a ReadOnlyJavaBeanBooleanPropertyBuilder has to be used.

As a minimum, the Java Bean must implement a getter for the property. If the getter of an instance of this class is called, the property of the Java Bean is returned. If the Java Bean property is bound (i.e. it supports PropertyChangeListeners), this ReadOnlyJavaBeanBooleanProperty will be aware of changes in the Java Bean. Otherwise it can be notified about changes by calling fireValueChangedEvent().

Since:

JavaFX 2.1

See Also:

ReadOnlyBooleanProperty, ReadOnlyJavaBeanBooleanPropertyBuilder

Method Summary

Modifier and Type	Method and Description
void	dispose() Signals to the JavaFX property that it will not be used anymore and any references can be removed.
void	fireValueChangedEvent() Sends notifications to all attached InvalidationListeners and ChangeListeners.
boolean	get() Returns the current value of this ObservableBooleanValue.
Object	getBean() Returns the Object that contains this property.
String	getName() Returns the name of this property.

Methods inherited from class javafx.beans.property.ReadOnlyBooleanPropertyBase

addListener, addListener, removeListener, removeListener

Methods inherited from class javafx.beans.property.ReadOnlyBooleanProperty

asObject, readOnlyBooleanProperty, toString

Methods inherited from class javafx.beans.binding.BooleanExpression

and, asString, booleanExpression, booleanExpression, getValue, isEqualTo, isNotEqualTo, not, or

Methods inherited from class java.lang.Object

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

Methods inherited from interface javafx.beans.value.ObservableValue

addListener, getValue, removeListener

Methods inherited from interface javafx.beans.Observable

addListener, removeListener

Method Detail

get

public boolean get()

Returns the current value of this ObservableBooleanValue.

Specified by:

get in interface ObservableBooleanValue

Returns:

The current value

Throws:

UndeclaredThrowableException - if calling the getter of the Java Bean property throws an IllegalAccessException or an InvocationTargetException.

getBean

public Object getBean()

Returns the Object that contains this property. If this property is not contained in an Object, null is returned.

Specified by:

getBean in interface ReadOnlyProperty<Boolean>

Returns:

the containing Object or null

getName

public String getName()

Returns the name of this property. If the property does not have a name, this method returns an empty String.

Specified by:

getName in interface ReadOnlyProperty<Boolean>

Returns:

the name or an empty String

fireValueChangedEvent

public void fireValueChangedEvent()

Sends notifications to all attached InvalidationListeners and ChangeListeners. This method needs to be called, if the value of this property changes.

Specified by:

fireValueChangedEvent in interface ReadOnlyJavaBeanProperty<Boolean>

Overrides:

fireValueChangedEvent in class ReadOnlyBooleanPropertyBase

dispose

public void dispose()

Signals to the JavaFX property that it will not be used anymore and any references can be removed. A call of this method usually results in the property stopping to observe the Java Bean property by unregistering its listener(s).

Specified by:

dispose in interface ReadOnlyJavaBeanProperty<Boolean>