Adding more @deprecates redirects where ever they seem useful.
Review by:jlabanca
git-svn-id: https://google-web-toolkit.googlecode.com/svn/releases/1.6@4411 8db76d5a-ed1c-0410-87a9-c151d255dfc7
diff --git a/user/src/com/google/gwt/user/client/History.java b/user/src/com/google/gwt/user/client/History.java
index bbac932..795ed67 100644
--- a/user/src/com/google/gwt/user/client/History.java
+++ b/user/src/com/google/gwt/user/client/History.java
@@ -77,6 +77,7 @@
* Adds a listener to be informed of changes to the browser's history stack.
*
* @param listener the listener to be added
+ * @deprecated use {@link History#addValueChangeHandler(ValueChangeHandler)} instead
*/
@Deprecated
public static void addHistoryListener(HistoryListener listener) {
@@ -88,6 +89,7 @@
* to be informed of changes to the browser's history stack.
*
* @param handler the handler
+ * @return the registration used to remove this value change handler
*/
public static HandlerRegistration addValueChangeHandler(
ValueChangeHandler<String> handler) {
diff --git a/user/src/com/google/gwt/user/client/HistoryListener.java b/user/src/com/google/gwt/user/client/HistoryListener.java
index b4a607f..b8cc0c1 100644
--- a/user/src/com/google/gwt/user/client/HistoryListener.java
+++ b/user/src/com/google/gwt/user/client/HistoryListener.java
@@ -18,6 +18,9 @@
/**
* Implement this interface to receive notification of changes to the browser
* history state. It is used with {@link com.google.gwt.user.client.History}.
+ *
+ * @deprecated use
+ * {@link History#addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler)} instead
*/
@Deprecated
public interface HistoryListener extends java.util.EventListener {
diff --git a/user/src/com/google/gwt/user/client/Window.java b/user/src/com/google/gwt/user/client/Window.java
index 9a55063..58ab514 100644
--- a/user/src/com/google/gwt/user/client/Window.java
+++ b/user/src/com/google/gwt/user/client/Window.java
@@ -399,7 +399,6 @@
private static boolean resizeHandlersInitialized;
private static final WindowImpl impl = GWT.create(WindowImpl.class);
-
/**
* Adds a {@link CloseEvent} handler.
*
@@ -426,6 +425,8 @@
/**
* Adds a listener to receive window closing events.
*
+ * @deprecated use {@link Window#addWindowClosingHandler(ClosingHandler)} and
+ * {@link Window#addCloseHandler(CloseHandler)} instead
* @param listener the listener to be informed when the window is closing
*/
@Deprecated
@@ -449,6 +450,7 @@
* Adds a listener to receive window resize events.
*
* @param listener the listener to be informed when the window is resized
+ * @deprecated use {@link Window#addResizeHandler(ResizeHandler)} instead
*/
@Deprecated
public static void addWindowResizeListener(WindowResizeListener listener) {
@@ -472,6 +474,7 @@
* Adds a listener to receive window scroll events.
*
* @param listener the listener to be informed when the window is scrolled
+ * @deprecated use {@link Window#addWindowScrollHandler(ScrollHandler)} instead
*/
@Deprecated
public static void addWindowScrollListener(WindowScrollListener listener) {
diff --git a/user/src/com/google/gwt/user/client/WindowCloseListener.java b/user/src/com/google/gwt/user/client/WindowCloseListener.java
index aa5806c..5e6ed4a 100644
--- a/user/src/com/google/gwt/user/client/WindowCloseListener.java
+++ b/user/src/com/google/gwt/user/client/WindowCloseListener.java
@@ -19,6 +19,9 @@
* Implement this interface to receive closing events from the browser window.
*
* @see com.google.gwt.user.client.Window#addWindowCloseListener(WindowCloseListener)
+ * @deprecated use {@link Window.ClosingHandler} and
+ * {@link com.google.gwt.event.logical.shared.CloseHandler} instead
+ *
*/
@Deprecated
public interface WindowCloseListener extends java.util.EventListener {
diff --git a/user/src/com/google/gwt/user/client/WindowResizeListener.java b/user/src/com/google/gwt/user/client/WindowResizeListener.java
index 04cfd25..4240327 100644
--- a/user/src/com/google/gwt/user/client/WindowResizeListener.java
+++ b/user/src/com/google/gwt/user/client/WindowResizeListener.java
@@ -19,6 +19,8 @@
* Implement this interface to receive resize events from the browser window.
*
* @see com.google.gwt.user.client.Window#addWindowResizeListener(WindowResizeListener)
+ * @deprecated use {@link com.google.gwt.event.logical.shared.ResizeHandler}
+ * instead
*/
@Deprecated
public interface WindowResizeListener extends java.util.EventListener {
diff --git a/user/src/com/google/gwt/user/client/WindowScrollListener.java b/user/src/com/google/gwt/user/client/WindowScrollListener.java
index bf3f3a1..186bb78 100644
--- a/user/src/com/google/gwt/user/client/WindowScrollListener.java
+++ b/user/src/com/google/gwt/user/client/WindowScrollListener.java
@@ -19,6 +19,9 @@
* Implement this interface to receive scroll events from the browser window.
*
* @see com.google.gwt.user.client.Window#addWindowScrollListener(WindowScrollListener)
+ * @deprecated use
+ * {@link Window#addWindowScrollHandler(com.google.gwt.user.client.Window.ScrollHandler)}
+ * instead instead
*/
@Deprecated
public interface WindowScrollListener extends java.util.EventListener {
diff --git a/user/src/com/google/gwt/user/client/ui/Button.java b/user/src/com/google/gwt/user/client/ui/Button.java
index c7738c8..e571bbd 100644
--- a/user/src/com/google/gwt/user/client/ui/Button.java
+++ b/user/src/com/google/gwt/user/client/ui/Button.java
@@ -99,6 +99,7 @@
*
* @param html the HTML caption
* @param listener the click listener
+ * @deprecated use {@link Button#Button(String, ClickHandler)} instead
*/
@Deprecated
public Button(String html, ClickListener listener) {
diff --git a/user/src/com/google/gwt/user/client/ui/DelegatingChangeListenerCollection.java b/user/src/com/google/gwt/user/client/ui/DelegatingChangeListenerCollection.java
index e283f85..c32c990 100644
--- a/user/src/com/google/gwt/user/client/ui/DelegatingChangeListenerCollection.java
+++ b/user/src/com/google/gwt/user/client/ui/DelegatingChangeListenerCollection.java
@@ -38,6 +38,8 @@
* changeListeners.add(listener);
* }
*</pre>
+ *
+ * @deprecated use <code>Widget#delegateEvent</code> instead
*/
@Deprecated
public class DelegatingChangeListenerCollection extends
diff --git a/user/src/com/google/gwt/user/client/ui/DelegatingClickListenerCollection.java b/user/src/com/google/gwt/user/client/ui/DelegatingClickListenerCollection.java
index 0e66518..f6feae8 100644
--- a/user/src/com/google/gwt/user/client/ui/DelegatingClickListenerCollection.java
+++ b/user/src/com/google/gwt/user/client/ui/DelegatingClickListenerCollection.java
@@ -38,6 +38,8 @@
* clickListeners.add(listener);
* }
*</pre>
+ *
+ * @deprecated use <code>Widget#delegateEvent</code> instead
*/
@Deprecated
public class DelegatingClickListenerCollection extends ClickListenerCollection
diff --git a/user/src/com/google/gwt/user/client/ui/DelegatingFocusListenerCollection.java b/user/src/com/google/gwt/user/client/ui/DelegatingFocusListenerCollection.java
index 7c937e0..9d26eee 100644
--- a/user/src/com/google/gwt/user/client/ui/DelegatingFocusListenerCollection.java
+++ b/user/src/com/google/gwt/user/client/ui/DelegatingFocusListenerCollection.java
@@ -38,6 +38,8 @@
* focusListeners.add(listener);
* }
*</pre>
+ *
+ * @deprecated use <code>Widget#delegateEvent</code> instead
*/
@Deprecated
public class DelegatingFocusListenerCollection extends FocusListenerCollection
diff --git a/user/src/com/google/gwt/user/client/ui/DelegatingKeyboardListenerCollection.java b/user/src/com/google/gwt/user/client/ui/DelegatingKeyboardListenerCollection.java
index fd62d7b..ccae9d2 100644
--- a/user/src/com/google/gwt/user/client/ui/DelegatingKeyboardListenerCollection.java
+++ b/user/src/com/google/gwt/user/client/ui/DelegatingKeyboardListenerCollection.java
@@ -39,6 +39,8 @@
* keyboardListeners.add(listener);
* }
*</pre>
+ *
+ * @deprecated use <code>Widget#delegateEvent</code> instead
*/
@Deprecated
public class DelegatingKeyboardListenerCollection extends
diff --git a/user/src/com/google/gwt/user/client/ui/DisclosureEvent.java b/user/src/com/google/gwt/user/client/ui/DisclosureEvent.java
index f5405d0..8488ed5 100644
--- a/user/src/com/google/gwt/user/client/ui/DisclosureEvent.java
+++ b/user/src/com/google/gwt/user/client/ui/DisclosureEvent.java
@@ -19,6 +19,10 @@
/**
* Event object containing information about {@link DisclosurePanel} changes.
+ *
+ * @deprecated use
+ * {@link com.google.gwt.event.logical.shared.CloseEvent} and
+ * {@link com.google.gwt.event.logical.shared.OpenEvent} instead
*/
@Deprecated
public class DisclosureEvent extends EventObject {
diff --git a/user/src/com/google/gwt/user/client/ui/DisclosureHandler.java b/user/src/com/google/gwt/user/client/ui/DisclosureHandler.java
index 90698f1..3145353 100644
--- a/user/src/com/google/gwt/user/client/ui/DisclosureHandler.java
+++ b/user/src/com/google/gwt/user/client/ui/DisclosureHandler.java
@@ -31,6 +31,8 @@
* Fired when the panel is closed.
*
* @param event event representing this action.
+ * @deprecated use {@link com.google.gwt.event.logical.shared.CloseHandler}
+ * instead
*/
@Deprecated
void onClose(DisclosureEvent event);
@@ -39,6 +41,7 @@
* Fired when the panel is opened.
*
* @param event event representing this action.
+ * @deprecated use {@link com.google.gwt.event.logical.shared.OpenHandler} instead
*/
@Deprecated
void onOpen(DisclosureEvent event);
diff --git a/user/src/com/google/gwt/user/client/ui/FocusListener.java b/user/src/com/google/gwt/user/client/ui/FocusListener.java
index 23b707d..fa82aca 100644
--- a/user/src/com/google/gwt/user/client/ui/FocusListener.java
+++ b/user/src/com/google/gwt/user/client/ui/FocusListener.java
@@ -30,6 +30,9 @@
* Fired when a widget receives keyboard focus.
*
* @param sender the widget receiving focus.
+ * @deprecated use
+ * {@link com.google.gwt.event.dom.client.FocusHandler#onFocus(com.google.gwt.event.dom.client.FocusEvent)}
+ * instead
*/
@Deprecated
void onFocus(Widget sender);
@@ -38,6 +41,9 @@
* Fired when a widget loses keyboard focus.
*
* @param sender the widget losing focus.
+ * @deprecated use
+ * {@link com.google.gwt.event.dom.client.BlurHandler#onBlur(com.google.gwt.event.dom.client.BlurEvent)}
+ * instead
*/
@Deprecated
void onLostFocus(Widget sender);
diff --git a/user/src/com/google/gwt/user/client/ui/FormHandler.java b/user/src/com/google/gwt/user/client/ui/FormHandler.java
index bbc1d33..cc18975 100644
--- a/user/src/com/google/gwt/user/client/ui/FormHandler.java
+++ b/user/src/com/google/gwt/user/client/ui/FormHandler.java
@@ -37,6 +37,7 @@
*
* @param event an event object containing information about the form
* submission
+ * @deprecated use {@link FormPanel.SubmitHandler} instead
*/
@Deprecated
void onSubmit(FormSubmitEvent event);
@@ -46,6 +47,7 @@
*
* @param event an event object containing information about the form
* submission
+ * @deprecated use {@link FormPanel.SubmitCompleteHandler} instead
*/
@Deprecated
void onSubmitComplete(FormSubmitCompleteEvent event);
diff --git a/user/src/com/google/gwt/user/client/ui/FormPanel.java b/user/src/com/google/gwt/user/client/ui/FormPanel.java
index 137322c..4aa7b90 100644
--- a/user/src/com/google/gwt/user/client/ui/FormPanel.java
+++ b/user/src/com/google/gwt/user/client/ui/FormPanel.java
@@ -183,6 +183,8 @@
/**
* This method is used for legacy support and should be removed when
* {@link FormHandler} is removed.
+ *
+ * @deprecated use {@link FormPanel.SubmitEvent#cancel()} instead
*/
@Deprecated
void setCanceled(boolean canceled) {
diff --git a/user/src/com/google/gwt/user/client/ui/HTMLTable.java b/user/src/com/google/gwt/user/client/ui/HTMLTable.java
index 77bd5eb..ee099c1 100644
--- a/user/src/com/google/gwt/user/client/ui/HTMLTable.java
+++ b/user/src/com/google/gwt/user/client/ui/HTMLTable.java
@@ -823,6 +823,7 @@
* @param listener listener to add
* @deprecated add a click handler instead and use {@link HTMLTable#getCellForEvent(ClickEvent)} to get the cell information
*/
+ @Deprecated
public void addTableListener(TableListener listener) {
ListenerWrapper.Table.add(this, listener);
}
diff --git a/user/src/com/google/gwt/user/client/ui/KeyboardListener.java b/user/src/com/google/gwt/user/client/ui/KeyboardListener.java
index dcf6b51..fbf314e 100644
--- a/user/src/com/google/gwt/user/client/ui/KeyboardListener.java
+++ b/user/src/com/google/gwt/user/client/ui/KeyboardListener.java
@@ -182,8 +182,14 @@
* value is a combination of the bits defined by
* {@link KeyboardListener#MODIFIER_SHIFT},
* {@link KeyboardListener#MODIFIER_CTRL}, and
- * {@link KeyboardListener#MODIFIER_ALT}.
+ * {@link KeyboardListener#MODIFIER_ALT}
+ *
+ *
+ * @deprecated use
+ * {@link com.google.gwt.event.dom.client.KeyDownHandler#onKeyDown(com.google.gwt.event.dom.client.KeyDownEvent)}
+ * instead
*/
+ @Deprecated
void onKeyDown(Widget sender, char keyCode, int modifiers);
/**
@@ -205,8 +211,12 @@
* value is a combination of the bits defined by
* {@link KeyboardListener#MODIFIER_SHIFT},
* {@link KeyboardListener#MODIFIER_CTRL}, and
- * {@link KeyboardListener#MODIFIER_ALT}.
+ * {@link KeyboardListener#MODIFIER_ALT}
+ * @deprecated use
+ * {@link com.google.gwt.event.dom.client.KeyPressHandler#onKeyPress(com.google.gwt.event.dom.client.KeyPressEvent)}
+ * instead
*/
+ @Deprecated
void onKeyPress(Widget sender, char keyCode, int modifiers);
/**
@@ -219,7 +229,11 @@
* value is a combination of the bits defined by
* {@link KeyboardListener#MODIFIER_SHIFT},
* {@link KeyboardListener#MODIFIER_CTRL}, and
- * {@link KeyboardListener#MODIFIER_ALT}.
+ * {@link KeyboardListener#MODIFIER_ALT}
+ * @deprecated use
+ * {@link com.google.gwt.event.dom.client.KeyUpHandler#onKeyUp(com.google.gwt.event.dom.client.KeyUpEvent)}
+ * instead
*/
+ @Deprecated
void onKeyUp(Widget sender, char keyCode, int modifiers);
}
diff --git a/user/src/com/google/gwt/user/client/ui/MouseListener.java b/user/src/com/google/gwt/user/client/ui/MouseListener.java
index 027eae0..0ad8fb8 100644
--- a/user/src/com/google/gwt/user/client/ui/MouseListener.java
+++ b/user/src/com/google/gwt/user/client/ui/MouseListener.java
@@ -35,21 +35,33 @@
* @param sender the widget sending the event
* @param x the x coordinate of the mouse
* @param y the y coordinate of the mouse
+ * @deprecated use
+ * {@link com.google.gwt.event.dom.client.MouseDownHandler#onMouseDown(com.google.gwt.event.dom.client.MouseDownEvent)}
+ * instead
*/
+ @Deprecated
void onMouseDown(Widget sender, int x, int y);
/**
* Fired when the mouse enters a widget's area.
*
* @param sender the widget sending the event
+ * @deprecated use
+ * {@link com.google.gwt.event.dom.client.MouseOverHandler#onMouseOver(com.google.gwt.event.dom.client.MouseOverEvent)}
+ * instead
*/
+ @Deprecated
void onMouseEnter(Widget sender);
/**
* Fired when the mouse leaves a widget's area.
*
* @param sender the widget sending the event
+ * @deprecated use
+ * {@link com.google.gwt.event.dom.client.MouseOutHandler#onMouseOut(com.google.gwt.event.dom.client.MouseOutEvent)}
+ * instead
*/
+ @Deprecated
void onMouseLeave(Widget sender);
/**
@@ -58,7 +70,11 @@
* @param sender the widget sending the event
* @param x the x coordinate of the mouse
* @param y the y coordinate of the mouse
+ * @deprecated use
+ * {@link com.google.gwt.event.dom.client.MouseMoveHandler#onMouseMove(com.google.gwt.event.dom.client.MouseMoveEvent)}
+ * instead
*/
+ @Deprecated
void onMouseMove(Widget sender, int x, int y);
/**
@@ -67,6 +83,10 @@
* @param sender the widget sending the event
* @param x the x coordinate of the mouse
* @param y the y coordinate of the mouse
+ * @deprecated use
+ * {@link com.google.gwt.event.dom.client.MouseUpHandler#onMouseUp(com.google.gwt.event.dom.client.MouseUpEvent)}
+ * instead
*/
+ @Deprecated
void onMouseUp(Widget sender, int x, int y);
}
diff --git a/user/src/com/google/gwt/user/client/ui/SuggestionHandler.java b/user/src/com/google/gwt/user/client/ui/SuggestionHandler.java
index 3d1ce7d..e11900b 100644
--- a/user/src/com/google/gwt/user/client/ui/SuggestionHandler.java
+++ b/user/src/com/google/gwt/user/client/ui/SuggestionHandler.java
@@ -21,6 +21,9 @@
* Event handler interface for {@link SuggestionEvent}.
*
* @see SuggestBox
+ *
+ * @deprecated use {@link com.google.gwt.event.logical.shared.SelectionHandler}
+ * instead
*/
@Deprecated
public interface SuggestionHandler extends EventListener {
@@ -30,8 +33,11 @@
* SuggestBox by clicking on one of the suggestions, or by pressing the ENTER
* key to select the suggestion that is currently highlighted.
*
- * @param event the object containing information about this event
+ * @param event the object containing information about this event deprecated
+ * use
+ * {@link com.google.gwt.event.logical.shared.SelectionHandler#onSelection(com.google.gwt.event.logical.shared.SelectionEvent)}
+ * instead
*/
- @Deprecated
+
void onSuggestionSelected(SuggestionEvent event);
}
diff --git a/user/src/com/google/gwt/user/client/ui/TabListener.java b/user/src/com/google/gwt/user/client/ui/TabListener.java
index 71f80ac..a6ebad7 100644
--- a/user/src/com/google/gwt/user/client/ui/TabListener.java
+++ b/user/src/com/google/gwt/user/client/ui/TabListener.java
@@ -21,6 +21,12 @@
* Event listener interface for tab events, used primarily by
* {@link com.google.gwt.user.client.ui.TabBar} and
* {@link com.google.gwt.user.client.ui.TabPanel}.
+ *
+ * @deprecated use
+ * {@link TabPanel#addBeforeSelectionHandler(com.google.gwt.event.logical.shared.BeforeSelectionHandler)}
+ * and/or
+ * {@link TabPanel#addSelectionHandler(com.google.gwt.event.logical.shared.SelectionHandler)}
+ * instead
*/
@Deprecated
public interface TabListener extends EventListener {
diff --git a/user/src/com/google/gwt/user/client/ui/TabListenerCollection.java b/user/src/com/google/gwt/user/client/ui/TabListenerCollection.java
index 4693454..968fed3 100644
--- a/user/src/com/google/gwt/user/client/ui/TabListenerCollection.java
+++ b/user/src/com/google/gwt/user/client/ui/TabListenerCollection.java
@@ -35,7 +35,6 @@
* @param sender the widget sending the event
* @param tabIndex the index of the tab being selected
*/
- @Deprecated
public boolean fireBeforeTabSelected(SourcesTabEvents sender, int tabIndex) {
for (TabListener listener : this) {
if (!listener.onBeforeTabSelected(sender, tabIndex)) {
@@ -51,7 +50,6 @@
* @param sender the widget sending the event
* @param tabIndex the index of the tab being selected
*/
- @Deprecated
public void fireTabSelected(SourcesTabEvents sender, int tabIndex) {
for (TabListener listener : this) {
listener.onTabSelected(sender, tabIndex);
diff --git a/user/src/com/google/gwt/user/client/ui/TableListener.java b/user/src/com/google/gwt/user/client/ui/TableListener.java
index eab2ec9..c714321 100644
--- a/user/src/com/google/gwt/user/client/ui/TableListener.java
+++ b/user/src/com/google/gwt/user/client/ui/TableListener.java
@@ -19,6 +19,10 @@
/**
* Event listener interface for table events.
+ *
+ * @deprecated use {@link com.google.gwt.event.dom.client.ClickHandler} and
+ * {@link HTMLTable#getCellForEvent(com.google.gwt.event.dom.client.ClickEvent)}
+ * instead
*/
@Deprecated
public interface TableListener extends EventListener {
@@ -29,6 +33,10 @@
* @param sender the widget sending the event
* @param row the row of the cell being clicked
* @param cell the index of the cell being clicked
+ *
+ * @deprecated use {@link com.google.gwt.event.dom.client.ClickHandler} and
+ * {@link HTMLTable#getCellForEvent(com.google.gwt.event.dom.client.ClickEvent)}
+ * instead
*/
@Deprecated
void onCellClicked(SourcesTableEvents sender, int row, int cell);
diff --git a/user/src/com/google/gwt/user/client/ui/TreeListener.java b/user/src/com/google/gwt/user/client/ui/TreeListener.java
index e879df6..c251be0 100644
--- a/user/src/com/google/gwt/user/client/ui/TreeListener.java
+++ b/user/src/com/google/gwt/user/client/ui/TreeListener.java
@@ -19,6 +19,10 @@
/**
* Event listener interface for tree events.
+ *
+ * @deprecated use {@link com.google.gwt.event.logical.shared.SelectionHandler},
+ * {@link com.google.gwt.event.logical.shared.OpenHandler}, and/or
+ * {@link com.google.gwt.event.logical.shared.CloseHandler} instead
*/
@Deprecated
public interface TreeListener extends EventListener {
@@ -27,6 +31,9 @@
* Fired when a tree item is selected.
*
* @param item the item being selected.
+ * @deprecated use
+ * {@link com.google.gwt.event.logical.shared.SelectionHandler#onSelection(com.google.gwt.event.logical.shared.SelectionEvent)}
+ * instead
*/
@Deprecated
void onTreeItemSelected(TreeItem item);
@@ -35,6 +42,10 @@
* Fired when a tree item is opened or closed.
*
* @param item the item whose state is changing.
+ * @deprecated use
+ * {@link com.google.gwt.event.logical.shared.OpenHandler#onOpen(com.google.gwt.event.logical.shared.OpenEvent)}
+ * and/or
+ * {@link com.google.gwt.event.logical.shared.CloseHandler#onClose(com.google.gwt.event.logical.shared.CloseEvent)}
*/
@Deprecated
void onTreeItemStateChanged(TreeItem item);
diff --git a/user/src/com/google/gwt/user/client/ui/TreeListenerCollection.java b/user/src/com/google/gwt/user/client/ui/TreeListenerCollection.java
index 92bd35d..f1099f5 100644
--- a/user/src/com/google/gwt/user/client/ui/TreeListenerCollection.java
+++ b/user/src/com/google/gwt/user/client/ui/TreeListenerCollection.java
@@ -32,7 +32,6 @@
*
* @param item the tree item being selected.
*/
- @Deprecated
public void fireItemSelected(TreeItem item) {
for (TreeListener listener : this) {
listener.onTreeItemSelected(item);
@@ -44,7 +43,6 @@
*
* @param item the tree item whose state has changed.
*/
- @Deprecated
public void fireItemStateChanged(TreeItem item) {
for (TreeListener listener : this) {
listener.onTreeItemStateChanged(item);
