Class StringProperty

java.lang.Object

javafx.beans.binding.StringExpression

javafx.beans.property.ReadOnlyStringProperty

javafx.beans.property.StringProperty

All Implemented Interfaces:

Observable, Property<String>, ReadOnlyProperty<String>, ObservableObjectValue<String>, ObservableStringValue, ObservableValue<String>, WritableObjectValue<String>, WritableStringValue, WritableValue<String>

Direct Known Subclasses:

JavaBeanStringProperty, StringPropertyBase

public abstract class StringProperty
extends ReadOnlyStringProperty
implements Property<String>, WritableStringValue

This class provides a full implementation of a Property wrapping a String value. The value of a StringProperty can be get and set with ObservableObjectValue.get(), StringExpression.getValue(), WritableObjectValue.set(Object), and setValue(String). A property can be bound and unbound unidirectional with Property.bind(ObservableValue) and Property.unbind(). Bidirectional bindings can be created and removed with bindBidirectional(Property) and unbindBidirectional(Property). The context of a StringProperty can be read with ReadOnlyProperty.getBean() and ReadOnlyProperty.getName().

Since:

JavaFX 2.0

See Also:

• ObservableStringValue
• WritableStringValue
• ReadOnlyStringProperty
• Property

Constructor Summary

Constructors

Constructor	Description
StringProperty()	Creates a default StringProperty.

Method Summary

Modifier and Type	Method	Description
void	bindBidirectional(Property<?> other, Format format)	Create a bidirectional binding between this StringProperty and another arbitrary property.
void	bindBidirectional(Property<String> other)	Create a bidirectional binding between this Property and another one.
<T> void	bindBidirectional(Property<T> other, StringConverter<T> converter)	Create a bidirectional binding between this StringProperty and another arbitrary property.
void	setValue(String v)	Set the wrapped value.
String	toString()	Returns a string representation of this StringProperty object.
void	unbindBidirectional(Object other)	Remove a bidirectional binding between this Property and another one.
void	unbindBidirectional(Property<String> other)	Removes a bidirectional binding between this Property and another one.

Methods declared in class StringExpression

concat, getValue, getValueSafe, greaterThan, greaterThan, greaterThanOrEqualTo, greaterThanOrEqualTo, isEmpty, isEqualTo, isEqualTo, isEqualToIgnoreCase, isEqualToIgnoreCase, isNotEmpty, isNotEqualTo, isNotEqualTo, isNotEqualToIgnoreCase, isNotEqualToIgnoreCase, isNotNull, isNull, length, lessThan, lessThan, lessThanOrEqualTo, lessThanOrEqualTo, stringExpression

Modifier and Type	Method	Description
StringExpression	concat(Object other)	Returns a StringExpression that holds the value of this StringExpression concatenated with another Object.
String	getValue()	Returns the current value of this ObservableValue
final String	getValueSafe()	Returns usually the value of this StringExpression.
BooleanBinding	greaterThan(String other)	Creates a new BooleanBinding that holds true if this StringExpression is greater than a constant value.
BooleanBinding	greaterThan(ObservableStringValue other)	Creates a new BooleanBinding that holds true if this StringExpression is greater than another ObservableStringValue.
BooleanBinding	greaterThanOrEqualTo(String other)	Creates a new BooleanBinding that holds true if this StringExpression is greater than or equal to a constant value.
BooleanBinding	greaterThanOrEqualTo(ObservableStringValue other)	Creates a new BooleanBinding that holds true if this StringExpression is greater than or equal to another ObservableStringValue.
BooleanBinding	isEmpty()	Creates a new BooleanBinding that holds true if this StringExpression is empty.
BooleanBinding	isEqualTo(String other)	Creates a new BooleanBinding that holds true if this StringExpression is equal to a constant value.
BooleanBinding	isEqualTo(ObservableStringValue other)	Creates a new BooleanBinding that holds true if this and another ObservableStringValue are equal.
BooleanBinding	isEqualToIgnoreCase(String other)	Creates a new BooleanBinding that holds true if this StringExpression is equal to a constant value ignoring case.
BooleanBinding	isEqualToIgnoreCase(ObservableStringValue other)	Creates a new BooleanBinding that holds true if this and another ObservableStringValue are equal ignoring case.
BooleanBinding	isNotEmpty()	Creates a new BooleanBinding that holds true if this StringExpression is not empty.
BooleanBinding	isNotEqualTo(String other)	Creates a new BooleanBinding that holds true if this StringExpression is not equal to a constant value.
BooleanBinding	isNotEqualTo(ObservableStringValue other)	Creates a new BooleanBinding that holds true if this and another ObservableStringValue are not equal.
BooleanBinding	isNotEqualToIgnoreCase(String other)	Creates a new BooleanBinding that holds true if this StringExpression is not equal to a constant value ignoring case.
BooleanBinding	isNotEqualToIgnoreCase(ObservableStringValue other)	Creates a new BooleanBinding that holds true if this and another ObservableStringValue are not equal ignoring case.
BooleanBinding	isNotNull()	Creates a new BooleanBinding that holds true if this StringExpression is not null.
BooleanBinding	isNull()	Creates a new BooleanBinding that holds true if this StringExpression is null.
IntegerBinding	length()	Creates a new IntegerBinding that holds the length of this StringExpression.
BooleanBinding	lessThan(String other)	Creates a new BooleanBinding that holds true if this StringExpression is less than a constant value.
BooleanBinding	lessThan(ObservableStringValue other)	Creates a new BooleanBinding that holds true if this StringExpression is less than another ObservableStringValue.
BooleanBinding	lessThanOrEqualTo(String other)	Creates a new BooleanBinding that holds true if this StringExpression is less than or equal to a constant value.
BooleanBinding	lessThanOrEqualTo(ObservableStringValue other)	Creates a new BooleanBinding that holds true if this StringExpression is less than or equal to another ObservableStringValue.
static StringExpression	stringExpression(ObservableValue<?> value)	Returns a StringExpression that wraps a ObservableValue.

Methods declared in class Object

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

Methods declared in interface Observable

addListener, removeListener, subscribe

Modifier and Type	Method	Description
void	addListener(InvalidationListener listener)	Adds an InvalidationListener which will be notified whenever the Observable becomes invalid.
void	removeListener(InvalidationListener listener)	Removes the given listener from the list of listeners, that are notified whenever the value of the Observable becomes invalid.
default Subscription	subscribe(Runnable invalidationSubscriber)	Creates a Subscription on this Observable which calls invalidationSubscriber whenever it becomes invalid.

Methods declared in interface ObservableObjectValue

get

Modifier and Type	Method	Description
String	get()	Returns the current value of this ObservableObjectValue<T>.

Methods declared in interface ObservableValue

addListener, flatMap, map, orElse, removeListener, subscribe, subscribe, when

Modifier and Type	Method	Description
void	addListener(ChangeListener<? super String> listener)	Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes.
default <U> ObservableValue<U>	flatMap(Function<? super String, ? extends ObservableValue<? extends U>> mapper)	Returns an ObservableValue that holds the value of an ObservableValue produced by applying the given mapping function on this value.
default <U> ObservableValue<U>	map(Function<? super String, ? extends U> mapper)	Returns an ObservableValue that holds the result of applying the given mapping function on this value.
default ObservableValue<String>	orElse(String constant)	Returns an ObservableValue that holds this value, or the given constant if it is null.
void	removeListener(ChangeListener<? super String> listener)	Removes the given listener from the list of listeners that are notified whenever the value of the ObservableValue changes.
default Subscription	subscribe(BiConsumer<? super String, ? super String> changeSubscriber)	Creates a Subscription on this ObservableValue which calls the given changeSubscriber with the old and new value whenever its value changes.
default Subscription	subscribe(Consumer<? super String> valueSubscriber)	Creates a Subscription on this ObservableValue which immediately provides the current value to the given valueSubscriber, followed by any subsequent values whenever its value changes.
default ObservableValue<String>	when(ObservableValue<Boolean> condition)	Returns an ObservableValue that holds this value and is updated only when condition holds true.

Methods declared in interface Property

bind, isBound, unbind

Modifier and Type	Method	Description
void	bind(ObservableValue<? extends String> observable)	Create a unidirection binding for this Property.
boolean	isBound()	Can be used to check, if a Property is bound.
void	unbind()	Remove the unidirectional binding for this Property.

Methods declared in interface ReadOnlyProperty

getBean, getName

Modifier and Type	Method	Description
Object	getBean()	Returns the Object that contains this property.
String	getName()	Returns the name of this property.

Methods declared in interface WritableObjectValue

get, set

Modifier and Type	Method	Description
String	get()	Get the wrapped value.
void	set(String value)	Set the wrapped value.

Methods declared in interface WritableValue

getValue

Modifier and Type	Method	Description
String	getValue()	Get the wrapped value.

Constructor Details

StringProperty

public StringProperty()

Creates a default StringProperty.

Method Details

setValue

public void setValue(String v)

Set the wrapped value.

Specified by:

setValue in interface WritableValue<String>

Parameters:

v - The new value

bindBidirectional

public void bindBidirectional(Property<String> other)

Create a bidirectional binding between this Property and another one. Bidirectional bindings exists independently of unidirectional bindings. So it is possible to add unidirectional binding to a property with bidirectional binding and vice-versa. However, this practice is discouraged.

It is possible to have multiple bidirectional bindings of one Property.

JavaFX bidirectional binding implementation use weak listeners. This means bidirectional binding does not prevent properties from being garbage collected.

Specified by:

bindBidirectional in interface Property<String>

Parameters:

other - the other Property

bindBidirectional

public void bindBidirectional(Property<?> other,
 Format format)

Create a bidirectional binding between this StringProperty and another arbitrary property. Relies on an implementation of Format for conversion.

Parameters:

other - the other Property

format - the Format used to convert between this StringProperty and the other Property

Throws:

NullPointerException - if other or format is null

IllegalArgumentException - if other is this

Since:

JavaFX 2.1

bindBidirectional

public <T> void bindBidirectional(Property<T> other,
 StringConverter<T> converter)

Create a bidirectional binding between this StringProperty and another arbitrary property. Relies on an implementation of StringConverter for conversion.

Type Parameters:

T - the type of the wrapped Object

Parameters:

other - the other Property

converter - the StringConverter used to convert between this StringProperty and the other Property

Throws:

NullPointerException - if other or converter is null

IllegalArgumentException - if other is this

Since:

JavaFX 2.1

unbindBidirectional

public void unbindBidirectional(Property<String> other)

Removes a bidirectional binding between this Property and another one. If no bidirectional binding between the properties exists, calling this method has no effect. It is possible to unbind by a call on the second property. This code will work:

    property1.bindBidirectional(property2);
    property2.unbindBidirectional(property1);

Specified by:

unbindBidirectional in interface Property<String>

Parameters:

other - the other Property

unbindBidirectional

public void unbindBidirectional(Object other)

Remove a bidirectional binding between this Property and another one. If no bidirectional binding between the properties exists, calling this method has no effect.

Parameters:

other - the other Property

Throws:

NullPointerException - if other is null

IllegalArgumentException - if other is this

Since:

JavaFX 2.1

toString

public String toString()

Returns a string representation of this StringProperty object.

Overrides:

toString in class ReadOnlyStringProperty

Returns:

a string representation of this StringProperty object.