Module javafx.base

Class FloatProperty

    • Constructor Detail

      • FloatProperty

        public FloatProperty()
    • Method Detail

      • bindBidirectional

        public void bindBidirectional​(Property<Number> 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<Number>
        Parameters:
        other - the other Property
      • unbindBidirectional

        public void unbindBidirectional​(Property<Number> 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<Number>
        Parameters:
        other - the other Property
      • toString

        public String toString()
        Returns a string representation of this FloatProperty object.
        Overrides:
        toString in class ReadOnlyFloatProperty
        Returns:
        a string representation of this FloatProperty object.
      • floatProperty

        public static FloatProperty floatProperty​(Property<Float> property)
        Returns a FloatProperty that wraps a Property and is bidirectionally bound to it. Changing this property will result in a change of the original property.

        This is very useful when bidirectionally binding an ObjectProperty<Float> and a FloatProperty.

           FloatProperty floatProperty = new SimpleFloatProperty(1.0f);
           ObjectProperty<Float> objectProperty = new SimpleObjectProperty<>(2.0f);
        
           // Need to keep the reference as bidirectional binding uses weak references
           FloatProperty objectAsFloat = FloatProperty.floatProperty(objectProperty);
        
           floatProperty.bindBidirectional(objectAsFloat);
        
         
        Another approach is to convert the FloatProperty to ObjectProperty using asObject() method.

        Note: null values in the source property will be interpreted as 0f

        Parameters:
        property - The source Property
        Returns:
        A FloatProperty that wraps the Property
        Throws:
        NullPointerException - if property is null
        Since:
        JavaFX 8.0
        See Also:
        asObject()
      • asObject

        public ObjectProperty<Float> asObject()
        Creates an ObjectProperty that bidirectionally bound to this FloatProperty. If the value of this FloatProperty changes, the value of the ObjectProperty will be updated automatically and vice-versa.

        Can be used for binding an ObjectProperty to FloatProperty.

           FloatProperty floatProperty = new SimpleFloatProperty(1.0f);
           ObjectProperty<Float> objectProperty = new SimpleObjectProperty<>(2.0f);
        
           objectProperty.bind(floatProperty.asObject());
         
        Overrides:
        asObject in class ReadOnlyFloatProperty
        Returns:
        the new ObjectProperty
        Since:
        JavaFX 8.0