javafx.beans.property

Class BooleanPropertyBase

java.lang.Object

BooleanExpression

javafx.beans.property.ReadOnlyBooleanProperty

javafx.beans.property.BooleanProperty

javafx.beans.property.BooleanPropertyBase

All Implemented Interfaces:

Property<java.lang.Boolean>, ReadOnlyProperty<java.lang.Boolean>

Direct Known Subclasses:

SimpleBooleanProperty

public abstract class BooleanPropertyBase
extends BooleanProperty

The class BooleanPropertyBase is the base class for a property wrapping a boolean value. It provides all the functionality required for a property except for the ReadOnlyProperty.getBean() and ReadOnlyProperty.getName() methods, which must be implemented by extending classes.

Since:

JavaFX 2.0

See Also:

BooleanProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	BooleanPropertyBase.Listener
private class	BooleanPropertyBase.ValueWrapper

Field Summary

Fields

Modifier and Type	Field and Description
private <any>	helper
private InvalidationListener	listener
private ObservableBooleanValue	observable
private boolean	valid
private boolean	value

Constructor Summary

Constructors

Constructor and Description
BooleanPropertyBase() The constructor of the BooleanPropertyBase.
BooleanPropertyBase(boolean initialValue) The constructor of the BooleanPropertyBase.

Method Summary

Modifier and Type	Method and Description
void	addListener(<any> listener)
void	addListener(InvalidationListener listener)
void	bind(<any> rawObservable) Create a unidirection binding for this Property.
protected void	fireValueChangedEvent() Sends notifications to all attached InvalidationListeners and ChangeListeners.
boolean	get()
protected void	invalidated() The method invalidated() can be overridden to receive invalidation notifications.
boolean	isBound() Can be used to check, if a Property is bound.
private void	markInvalid()
void	removeListener(<any> listener)
void	removeListener(InvalidationListener listener)
void	set(boolean newValue)
java.lang.String	toString() Returns a string representation of this BooleanPropertyBase object.
void	unbind() Remove the unidirectional binding for this Property.

Methods inherited from class javafx.beans.property.BooleanProperty

asObject, bindBidirectional, booleanProperty, setValue, unbindBidirectional

Methods inherited from class javafx.beans.property.ReadOnlyBooleanProperty

readOnlyBooleanProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface javafx.beans.property.ReadOnlyProperty

getBean, getName

Field Detail

value

private boolean value

observable

private ObservableBooleanValue observable

listener

private InvalidationListener listener

valid

private boolean valid

helper

private <any> helper

Constructor Detail

BooleanPropertyBase

public BooleanPropertyBase()

The constructor of the BooleanPropertyBase.

BooleanPropertyBase

public BooleanPropertyBase(boolean initialValue)

The constructor of the BooleanPropertyBase.

Parameters:

initialValue - the initial value of the wrapped value

Method Detail

addListener

public void addListener(InvalidationListener listener)

removeListener

public void removeListener(InvalidationListener listener)

addListener

public void addListener(<any> listener)

removeListener

public void removeListener(<any> listener)

fireValueChangedEvent

protected void fireValueChangedEvent()

Sends notifications to all attached InvalidationListeners and ChangeListeners. This method is called when the value is changed, either manually by calling set(boolean) or in case of a bound property, if the binding becomes invalid.

markInvalid

private void markInvalid()

invalidated

protected void invalidated()

The method invalidated() can be overridden to receive invalidation notifications. This is the preferred option in Objects defining the property, because it requires less memory. The default implementation is empty.

get

public boolean get()

set

public void set(boolean newValue)

isBound

public boolean isBound()

Can be used to check, if a Property is bound.

Returns:

true if the Property is bound, false otherwise

See Also:

#bind(javafx.beans.value.ObservableValue)

bind

public void bind(<any> rawObservable)

Create a unidirection binding for this Property.

Note that JavaFX has all the bind calls implemented through weak listeners. This means the bound property can be garbage collected and stopped from being updated. Note:

Parameters:

rawObservable - The observable this Property should be bound to.

unbind

public void unbind()

Remove the unidirectional binding for this Property. If the Property is not bound, calling this method has no effect.

See Also:

#bind(javafx.beans.value.ObservableValue)

toString

public java.lang.String toString()

Returns a string representation of this BooleanPropertyBase object.

Overrides:

toString in class BooleanProperty

Returns:

a string representation of this BooleanPropertyBase object.