summaryrefslogtreecommitdiffstats
path: root/bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/widgets/Widget.java
diff options
context:
space:
mode:
authorCarolyn MacLeod <carolyn>2006-05-03 20:02:09 +0000
committerCarolyn MacLeod <carolyn>2006-05-03 20:02:09 +0000
commite880a6e84e2c212aad35915a8e501a30b543c4fe (patch)
tree33caaa46660a67b93663d6f950933dbf725b03f3 /bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/widgets/Widget.java
parentdd2daaefe7b01d6308af5987fb9008de6a622b64 (diff)
downloadeclipse.platform.swt-e880a6e84e2c212aad35915a8e501a30b543c4fe.tar.gz
eclipse.platform.swt-e880a6e84e2c212aad35915a8e501a30b543c4fe.tar.xz
eclipse.platform.swt-e880a6e84e2c212aad35915a8e501a30b543c4fe.zip
Javadoc basher output for 3.2RC3
Diffstat (limited to 'bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/widgets/Widget.java')
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/widgets/Widget.java33
1 files changed, 24 insertions, 9 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/widgets/Widget.java b/bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/widgets/Widget.java
index 23c075b64c..98d4c00796 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/widgets/Widget.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT/motif/org/eclipse/swt/widgets/Widget.java
@@ -155,9 +155,10 @@ public Widget (Widget parent, int style) {
}
/**
* Adds the listener to the collection of listeners who will
- * be notifed when an event of the given type occurs. When the
+ * be notified when an event of the given type occurs. When the
* event does occur in the widget, the listener is notified by
- * sending it the <code>handleEvent()</code> message.
+ * sending it the <code>handleEvent()</code> message. The event
+ * type is one of the event constants defined in class <code>SWT</code>.
*
* @param eventType the type of event to listen for
* @param listener the listener which should be notified when the event occurs
@@ -171,7 +172,9 @@ public Widget (Widget parent, int style) {
* </ul>
*
* @see Listener
+ * @see SWT
* @see #removeListener
+ * @see #notifyListeners
*/
public void addListener (int eventType, Listener handler) {
checkWidget();
@@ -181,7 +184,7 @@ public void addListener (int eventType, Listener handler) {
}
/**
* Adds the listener to the collection of listeners who will
- * be notifed when the widget is disposed. When the widget is
+ * be notified when the widget is disposed. When the widget is
* disposed, the listener is notified by sending it the
* <code>widgetDisposed()</code> message.
*
@@ -516,15 +519,18 @@ public boolean isDisposed () {
/**
* Returns <code>true</code> if there are any listeners
* for the specified event type associated with the receiver,
- * and <code>false</code> otherwise.
+ * and <code>false</code> otherwise. The event type is one of
+ * the event constants defined in class <code>SWT</code>.
*
- * @param eventType the type of event
+ * @param eventType the type of event
* @return true if the event is hooked
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
+ *
+ * @see SWT
*/
public boolean isListening (int eventType) {
checkWidget();
@@ -542,7 +548,9 @@ void manageChildren () {
/**
* Notifies all of the receiver's listeners for events
* of the given type that one such event has occurred by
- * invoking their <code>handleEvent()</code> method.
+ * invoking their <code>handleEvent()</code> method. The
+ * event type is one of the event constants defined in class
+ * <code>SWT</code>.
*
* @param eventType the type of event which has occurred
* @param event the event data
@@ -551,6 +559,10 @@ void manageChildren () {
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
+ *
+ * @see SWT
+ * @see #addListener
+ * @see #removeListener
*/
public void notifyListeners (int eventType, Event event) {
checkWidget();
@@ -655,7 +667,8 @@ void releaseWidget () {
}
/**
* Removes the listener from the collection of listeners who will
- * be notifed when an event of the given type occurs.
+ * be notified when an event of the given type occurs. The event
+ * type is one of the event constants defined in class <code>SWT</code>.
*
* @param eventType the type of event to listen for
* @param listener the listener which should no longer be notified when the event occurs
@@ -669,7 +682,9 @@ void releaseWidget () {
* </ul>
*
* @see Listener
+ * @see SWT
* @see #addListener
+ * @see #notifyListeners
*/
public void removeListener (int eventType, Listener handler) {
checkWidget();
@@ -679,7 +694,7 @@ public void removeListener (int eventType, Listener handler) {
}
/**
* Removes the listener from the collection of listeners who will
- * be notifed when an event of the given type occurs.
+ * be notified when an event of the given type occurs.
* <p>
* <b>IMPORTANT:</b> This method is <em>not</em> part of the SWT
* public API. It is marked public only so that it can be shared
@@ -709,7 +724,7 @@ protected void removeListener (int eventType, SWTEventListener handler) {
}
/**
* Removes the listener from the collection of listeners who will
- * be notifed when the widget is disposed.
+ * be notified when the widget is disposed.
*
* @param listener the listener which should no longer be notified when the receiver is disposed
*