All Downloads are FREE. Search and download functionalities are using the official Maven repository.

jfxtras.labs.util.HeterogeneousBidirectionalBinder Maven / Gradle / Ivy

Go to download

Experimental components for JavaFX 2

There is a newer version: 9.0-r1
Show newest version
/**
 * HeterogeneousBidirectionalBinder.java
 *
 * Copyright (c) 2011-2015, JFXtras
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the organization nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL  BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package jfxtras.labs.util;

import javafx.beans.WeakListener;
import javafx.beans.property.Property;
import javafx.beans.value.ChangeListener;
import javafx.beans.value.ObservableValue;

import java.lang.ref.WeakReference;
import java.util.function.Function;

/**
 * A bidirectional object binding between two properties of different types.
 * It is a bindER rather than bindING for two reasons:
 * 
    
 *     
  •  We can't extend the original BidirectionalBinding since it has a private constructor 
    • 
 *     
  •  It doesn't use static methods and it's a simple object you want to keep a reference around 
    • 
 * 

 * The bind is effective from the constructor until unbind() is called. It is registered as a weaklistener to both properties.
 * 

 * Much like the oiginal BidirectionalBinding using StringConverter, you can have multiple bidirectional binders active at the same time.
 * Because they are glorified listeners multiple binders are activated in order of creation.
 * Still, avoid multiple active binders as the transformations of variables concatenate in usually strange fashion.
 *
 * Created by carrknight on 4/26/14.
 */
public class HeterogeneousBidirectionalBinder implements ChangeListener, WeakListener {

    //the use of WeakReferences here is just to mimic BidirectionalBindings
    private final WeakReference> propertyRef1;
    private final WeakReference> propertyRef2;
    //the nice thing about Function of java 8 is that I don't need to keep around apache transformer from commons as a dependency
    private final Function transformer1To2;
    private final Function transformer2To1;

    //flag to avoid infinite recursion
    private boolean updating = false;


    //use the same hash-code idea of the original BidirectionalBinding, except that i also multiply by the hashcodes of the transformers
    private final int cachedHashCode;

    public HeterogeneousBidirectionalBinder(Property property1, Property property2,
                                            Function transformer1To2, Function transformer2To1) {
        initCheck(property1, property2,transformer1To2,transformer2To1);

        propertyRef1 = new WeakReference<>(property1);
        propertyRef2 = new WeakReference<>(property2);
        this.transformer1To2 = transformer1To2;
        this.transformer2To1 = transformer2To1;

        //well, start listening
        property1.setValue(transformer2To1.apply(property2.getValue()));
        property1.addListener(this);
        property2.addListener(this);


        cachedHashCode = propertyRef1.hashCode() * propertyRef2.hashCode() * transformer1To2.hashCode() * transformer2To1.hashCode();
    }

    private void initCheck(Property property1, Property property2,
                           Function transformer1To2, Function transformer2To1) {
        if(property1 == property2 ||property1 == null || property2 == null )
            throw new IllegalArgumentException("Properties must be different and not null");
        if(transformer1To2 == null || transformer2To1 == null  )
            throw new IllegalArgumentException("Transformers can't be null!");


    }

    public Property getProperty1() {
        return propertyRef1.get();
    }

    public Property getProperty2() {
        return propertyRef2.get();
    }


    /**
     * This is the core of the binding. It is a method that listens to both properties.
     * It takes as basis the open source javafx method for BidirectionalBinding (here: http://hg.openjdk.java.net/openjfx/8/master/rt/file/f89b7dc932af/modules/base/src/main/java/com/sun/javafx/binding/BidirectionalBinding.java )
     * the only main difference is that in this method i called the transformers. It's another unfortunate byproduct of BidirectionalBindings having private constructors.
     *
     */
    @Override
    public void changed(ObservableValue sourceProperty, Object oldValue, Object newValue) {
        //this is basically copy-pasted from the javafx 8 source, commented at random by me
        if (!updating) {  //flag updating spares us from infinite recursion
            final Property property1 = propertyRef1.get(); //get the two properties
            final Property property2 = propertyRef2.get();
            if ((property1 == null) || (property2 == null)) {
                if (property1 != null) {
                    property1.removeListener(this); //don't bother listening if the other one is null
                }
                if (property2 != null) {
                    property2.removeListener(this);
                }
            } else {
                try {
                    updating = true; //set updating to true to avoid infinite recursion
                    updateProperty(sourceProperty, newValue);
                } catch (RuntimeException e) {
                    //if we fail, grab the old value, cast it, transform it and apply it.
                    updateProperty(sourceProperty,oldValue);
                    //but in the end just throw a new runtime exception here.
                    throw new RuntimeException(
                            "BidirectionalBinder failed, setting to the previous value", e);
                } finally {
                    updating = false;
                }
            }
        }
    }

    /**
     *     a simple helper to update the right property. Called by the change listener method
     */
    @SuppressWarnings("unchecked")
    private void updateProperty(ObservableValue sourceProperty, Object value) {
        if (getProperty1() == sourceProperty) {
            //grab the value, cast it, transform it and apply it!
            A newTypedValue = (A) value;
            getProperty2().setValue(transformer1To2.apply(newTypedValue));
        } else {
            B newTypedValue = (B) value;
            getProperty1().setValue(transformer2To1.apply(newTypedValue));
        }
    }


    @Override
    public int hashCode() {
        return cachedHashCode;
    }


    public void unbind(){

        final Property property1 = propertyRef1.get();
        if(property1 != null)
            property1.removeListener(this);

        final Property property2 = propertyRef2.get();
        if(property2!= null)
            property2.removeListener(this);
    }

    /**
     * copy pasted from the javafx8 source code: http://hg.openjdk.java.net/openjfx/8/master/rt/file/f89b7dc932af/modules/base/src/main/java/com/sun/javafx/binding/BidirectionalBinding.java
     * @return whether either property is null
     */
    @Override
    public boolean wasGarbageCollected() {
        return (getProperty1() == null) || (getProperty2() == null);
    }


    /**
     * equality is just "==".
     */
    @Override
    public boolean equals(Object o) {
        return this == o;

        /*
         If I ever decide to build a parallel static structure like the original binders then I'll have to change
          the equals(o) to some deep-equality like below.
          The reason is that the static unbind() works by just calling removeListener(.) which in turn works through equals.

        if (o == null || getClass() != o.getClass()) return false;

        HeterogeneousBidirectionalBinder that = (HeterogeneousBidirectionalBinder) o;

        //if one is null and the other isn't
        return Objects.equals(this.propertyRef1.get(),that.propertyRef1.get())
                &&
                Objects.equals(this.propertyRef2.get(),that.propertyRef2.get())
                &&
                Objects.equals(this.transformer1To2,that.transformer1To2)
                &&
                Objects.equals(this.transformer2To1,that.transformer2To1);
*/
    }


}

    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy