javadoc

8 files changed, 135 insertions, 32 deletions

diff --git a/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/LocationEvent.java b/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/LocationEvent.java
index 2dab5d7f7a..4bb8e808f0 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/LocationEvent.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/LocationEvent.java
@@ -17,6 +17,13 @@ import org.eclipse.swt.events.*;
  * This event is sent to LocationListeners when the location
  * is changed.
  * 
+ * <p>
+ * NOTE: The API in the browser package is NOT finalized.
+ * Use at your own risk, because it will most certainly change.
+ * The only reason this API is being released at this time is so that 
+ * other teams can try it out.
+ * </p>
+ * 
  * @since 3.0
  */
 public class LocationEvent extends TypedEvent {
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/LocationListener.java b/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/LocationListener.java
index 944c053973..fea8af2ba2 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/LocationListener.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/LocationListener.java
@@ -16,21 +16,28 @@ import org.eclipse.swt.internal.SWTEventListener;
  * This listener interface may be implemented in order to receive
  * LocationEvents.
  * 
+ * <p>
+ * NOTE: The API in the browser package is NOT finalized.
+ * Use at your own risk, because it will most certainly change.
+ * The only reason this API is being released at this time is so that 
+ * other teams can try it out.
+ * </p>
+ * 
  * @see LocationEvent
  * 
  * @since 3.0
  */
 public interface LocationListener extends SWTEventListener {
 
-	/**
-	 * This method is called when the current location is changed.
-	 * <p>
-	 *
-	 * @param event.location the current location 
-	 *
-	 * @see LocationEvent
-	 * 
-	 * @since 3.0
-	 */ 
-	public void changed(LocationEvent event);
+/**
+ * This method is called when the current location is changed.
+ * <p>
+ *
+ * @param event.location the current location 
+ *
+ * @see LocationEvent
+ * 
+ * @since 3.0
+ */ 
+public void changed(LocationEvent event);
 }
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/ProgressAdapter.java b/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/ProgressAdapter.java
new file mode 100644
index 0000000000..9da9be03e0
--- /dev/null
+++ b/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/ProgressAdapter.java
@@ -0,0 +1,56 @@
+/*******************************************************************************
+ * Copyright (c) 2003 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials 
+ * are made available under the terms of the Common Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/cpl-v10.html
+ * 
+ * Contributors:
+ *     IBM Corporation - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.swt.browser;
+
+/**
+ * This adapter class provides default implementations for the
+ * methods described by the <code>ProgressListener</code> interface.
+ * <p>
+ * Classes that wish to deal with <code>ProgressEvent</code>s can
+ * extend this class and override only the methods which they are
+ * interested in.
+ * </p><p>
+ * NOTE: The API in the browser package is NOT finalized.
+ * Use at your own risk, because it will most certainly change.
+ * The only reason this API is being released at this time is so that 
+ * other teams can try it out.
+ * </p>
+ * 
+ * @see ProgressListener
+ * @see ProgressEvent
+ */
+public abstract class ProgressAdapter implements ProgressListener {
+
+/**
+ * This method is called when a progress is made during the loading of the current location.
+ * <p>
+ *
+ * @param event.current the progress for the location currently being loaded
+ * @param event.total the maximum progress for the location currently being loaded
+ *
+ * @see ProgressEvent
+ * 
+ * @since 3.0
+ */   
+public void changed(ProgressEvent event) {
+}
+	
+/**
+ * This method is called when the current location has been completely loaded.
+ * <p>
+ *
+ * @see ProgressEvent
+ * 
+ * @since 3.0
+ */
+public void completed(ProgressEvent event) {
+}
+}
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/ProgressEvent.java b/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/ProgressEvent.java
index d332b5b7f8..588e8d5bbe 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/ProgressEvent.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/ProgressEvent.java
@@ -18,6 +18,13 @@ import org.eclipse.swt.events.*;
  * during the loading of the current URI or when the loading of the
  * current URI has been completed.
  * 
+ * <p>
+ * NOTE: The API in the browser package is NOT finalized.
+ * Use at your own risk, because it will most certainly change.
+ * The only reason this API is being released at this time is so that 
+ * other teams can try it out.
+ * </p>
+ * 
  * @since 3.0
  */
 public class ProgressEvent extends TypedEvent {
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/ProgressListener.java b/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/ProgressListener.java
index 06a792f226..e708d6b53c 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/ProgressListener.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/ProgressListener.java
@@ -16,32 +16,39 @@ import org.eclipse.swt.internal.SWTEventListener;
  * This listener interface may be implemented in order to receive
  * ProgressEvents.
  * 
+ * <p>
+ * NOTE: The API in the browser package is NOT finalized.
+ * Use at your own risk, because it will most certainly change.
+ * The only reason this API is being released at this time is so that 
+ * other teams can try it out.
+ * </p>
+ * 
  * @see ProgressEvent
  * 
  * @since 3.0
  */
 public interface ProgressListener extends SWTEventListener {
 	
-	/**
-	 * This method is called when a progress is made during the loading of the current location.
-	 * <p>
-	 *
-	 * @param event.current the progress for the location currently being loaded
-	 * @param event.total the maximum progress for the location currently being loaded
-	 *
-	 * @see ProgressEvent
-	 * 
-	 * @since 3.0
-	 */   
-	public void changed(ProgressEvent event);
+/**
+ * This method is called when a progress is made during the loading of the current location.
+ * <p>
+ *
+ * @param event.current the progress for the location currently being loaded
+ * @param event.total the maximum progress for the location currently being loaded
+ *
+ * @see ProgressEvent
+ * 
+ * @since 3.0
+ */   
+public void changed(ProgressEvent event);
 	
-	/**
-	 * This method is called when the current location has been completely loaded.
-	 * <p>
-	 *
-	 * @see ProgressEvent
-	 * 
-	 * @since 3.0
-	 */
-	public void completed(ProgressEvent event);
+/**
+ * This method is called when the current location has been completely loaded.
+ * <p>
+ *
+ * @see ProgressEvent
+ * 
+ * @since 3.0
+ */
+public void completed(ProgressEvent event);
 }
\ No newline at end of file
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/StatusTextEvent.java b/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/StatusTextEvent.java
index a7c5d62350..7890f797d1 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/StatusTextEvent.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/StatusTextEvent.java
@@ -18,6 +18,13 @@ import org.eclipse.swt.events.*;
  * is changed.  The status text is typically displayed in the status
  * bar of a browser.
  * 
+ * <p>
+ * NOTE: The API in the browser package is NOT finalized.
+ * Use at your own risk, because it will most certainly change.
+ * The only reason this API is being released at this time is so that 
+ * other teams can try it out.
+ * </p>
+ * 
  * @since 3.0
  */
 public class StatusTextEvent extends TypedEvent {
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/StatusTextListener.java b/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/StatusTextListener.java
index a9f56e434e..daa6ae4e0d 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/StatusTextListener.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/StatusTextListener.java
@@ -16,6 +16,13 @@ import org.eclipse.swt.internal.SWTEventListener;
  * This listener interface may be implemented in order to receive
  * StatusTextEvents.
  * 
+ * <p>
+ * NOTE: The API in the browser package is NOT finalized.
+ * Use at your own risk, because it will most certainly change.
+ * The only reason this API is being released at this time is so that 
+ * other teams can try it out.
+ * </p>
+ * 
  * @see StatusTextEvent
  */
 public interface StatusTextListener extends SWTEventListener {
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Browser/win32/org/eclipse/swt/browser/Browser.java b/bundles/org.eclipse.swt/Eclipse SWT Browser/win32/org/eclipse/swt/browser/Browser.java
index e8363d255d..7e09895787 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT Browser/win32/org/eclipse/swt/browser/Browser.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Browser/win32/org/eclipse/swt/browser/Browser.java
@@ -23,6 +23,11 @@ import org.eclipse.swt.widgets.*;
  * it does not make sense to set a layout on it.
  * </p><p>
  * IMPORTANT: This class is <em>not</em> intended to be subclassed.
+ * </p><p>
+ * NOTE: The API in the browser package is NOT finalized.
+ * Use at your own risk, because it will most certainly change.
+ * The only reason this API is being released at this time is so that 
+ * other teams can try it out.
  * </p>
  * 
  * @since 3.0