Module javafx.base

Package javafx.beans.property

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()

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)	Remove a bidirectional binding between this Property and another one.

Methods inherited from class java.lang.Object

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

Methods inherited from interface javafx.beans.Observable

addListener, removeListener

Methods inherited from interface javafx.beans.value.ObservableObjectValue

get

Methods inherited from interface javafx.beans.value.ObservableValue

addListener, getValue, removeListener

Methods inherited from interface javafx.beans.property.Property

bind, isBound, unbind

Methods inherited from interface javafx.beans.property.ReadOnlyProperty

getBean, getName

Methods inherited from class javafx.beans.binding.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

Methods inherited from interface javafx.beans.value.WritableObjectValue

get, set

Methods inherited from interface javafx.beans.value.WritableValue

getValue

Constructor Detail

StringProperty

public StringProperty()

Method Detail

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)

Remove 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.bindBirectional(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.