diff org.eclipse.core.databinding/src/org/eclipse/core/databinding/observable/value/ValueChangingEvent.d @ 78:0a55d2d5a946

Added file for databinding
author Frank Benoit <benoit@tionex.de>
date Tue, 14 Apr 2009 11:35:29 +0200
parents
children 383ce7bd736b
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/org.eclipse.core.databinding/src/org/eclipse/core/databinding/observable/value/ValueChangingEvent.d	Tue Apr 14 11:35:29 2009 +0200
@@ -0,0 +1,76 @@
+/*******************************************************************************
+ * Copyright (c) 2006, 2007 IBM Corporation 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:
+ *     IBM Corporation - initial API and implementation
+ ******************************************************************************/
+
+module org.eclipse.core.databinding.observable.value.ValueChangingEvent;
+
+import java.lang.all;
+
+import org.eclipse.core.databinding.observable.IObservablesListener;
+import org.eclipse.core.databinding.observable.ObservableEvent;
+
+/**
+ * Value changing event describing a pending change of an
+ * {@link IObservableValue} object's current value. Listeners can veto the
+ * pending change by setting {@link #veto} to <code>true</code>.
+ * 
+ * @since 1.0
+ * 
+ */
+public class ValueChangingEvent : ObservableEvent {
+
+    /**
+     * 
+     */
+    private static final long serialVersionUID = 2305345286999701156L;
+
+    static final Object TYPE = new Object();
+
+    /**
+     * Description of the change to the source observable value. Listeners must
+     * not change this field.
+     */
+    public ValueDiff diff;
+
+    /**
+     * Flag for vetoing this change. Default value is <code>false</code>, can
+     * be set to <code>true</code> by listeners to veto this change.
+     */
+    public bool veto = false;
+
+    /**
+     * Creates a new value changing event.
+     * 
+     * @param source
+     *            the source observable value
+     * @param diff
+     *            the value change
+     */
+    public this(IObservableValue source, ValueDiff diff) {
+        super(source);
+        this.diff = diff;
+    }
+
+    /**
+     * @return the observable value from which this event originated
+     */
+    public IObservableValue getObservableValue() {
+        return cast(IObservableValue) source;
+    }
+
+    protected void dispatch(IObservablesListener listener) {
+        (cast(IValueChangingListener) listener).handleValueChanging(this);
+    }
+
+    protected Object getListenerType() {
+        return TYPE;
+    }
+
+}