de.walware.ecommons.databinding.jface.AbstractSWTObservableValue.java Source code

Introduction

Here is the source code for de.walware.ecommons.databinding.jface.AbstractSWTObservableValue.java

Source

/*=============================================================================#
 # Copyright (c) 2006-2015 The Pampered Chef, Inc. and others.
 # All rights reserved. This program and the accompanying materials
 # are made available under the terms of the Eclipse Public License v1.0
 # which accompanies this distribution, and is available at
 # http://www.eclipse.org/legal/epl-v10.html
 # 
 # Contributors:
 #     The Pampered Chef, Inc. - initial API and implementation
 #=============================================================================*/

package de.walware.ecommons.databinding.jface;

import org.eclipse.core.databinding.observable.Realm;
import org.eclipse.core.databinding.observable.value.AbstractObservableValue;
import org.eclipse.jface.databinding.swt.ISWTObservableValue;
import org.eclipse.jface.databinding.swt.SWTObservables;
import org.eclipse.swt.events.DisposeEvent;
import org.eclipse.swt.events.DisposeListener;
import org.eclipse.swt.widgets.Widget;

/**
 * NON-API - An abstract superclass for observable values that gurantees that the 
 * observable will be disposed when the control to which it is attached is
 * disposed.
 * 
 * @since 1.1
 */
public abstract class AbstractSWTObservableValue extends AbstractObservableValue implements ISWTObservableValue {

    private final Widget widget;

    /**
     * Standard constructor for an SWT ObservableValue.  Makes sure that
     * the observable gets disposed when the SWT widget is disposed.
     * 
     * @param widget
     */
    protected AbstractSWTObservableValue(final Widget widget) {
        this(SWTObservables.getRealm(widget.getDisplay()), widget);
    }

    /**
     * Constructor that allows for the setting of the realm. Makes sure that the
     * observable gets disposed when the SWT widget is disposed.
     * 
     * @param realm
     * @param widget
     * @since 1.2
     */
    protected AbstractSWTObservableValue(final Realm realm, final Widget widget) {
        super(realm);
        this.widget = widget;
        widget.addDisposeListener(new DisposeListener() {
            @Override
            public void widgetDisposed(final DisposeEvent e) {
                AbstractSWTObservableValue.this.dispose();
            }
        });
    }

    /**
     * @return Returns the widget.
     */
    @Override
    public Widget getWidget() {
        return widget;
    }

}