diff options
author | Carolyn MacLeod <carolyn> | 2011-05-09 17:12:22 +0000 |
---|---|---|
committer | Carolyn MacLeod <carolyn> | 2011-05-09 17:12:22 +0000 |
commit | 0c693ec68aa92990fed67d5ac8294b0904382aa6 (patch) | |
tree | b59636fb131d9237001b502c89ac93b81a964fdf /bundles/org.eclipse.swt/Eclipse SWT/photon/org | |
parent | d05fd93fefebb6bc1d07ca12de432d36944a8740 (diff) | |
download | eclipse.platform.swt-0c693ec68aa92990fed67d5ac8294b0904382aa6.tar.gz eclipse.platform.swt-0c693ec68aa92990fed67d5ac8294b0904382aa6.tar.xz eclipse.platform.swt-0c693ec68aa92990fed67d5ac8294b0904382aa6.zip |
After javadoc bash for 3.7RC1AFTER_JAVADOC_BASH_FOR_37RC1
Diffstat (limited to 'bundles/org.eclipse.swt/Eclipse SWT/photon/org')
5 files changed, 106 insertions, 15 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/Control.java b/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/Control.java index 1b8805a6b3..7fc70cf2e3 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/Control.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/Control.java @@ -178,7 +178,7 @@ public void addFocusListener (FocusListener listener) { /** * Adds the listener to the collection of listeners who will * be notified when gesture events are generated for the control, - * by sending it one of the messages defined in the + * by sending it one of the messages defined in the * <code>GestureListener</code> interface. * * @param listener the listener which should be notified @@ -441,6 +441,8 @@ public void addPaintListener (PaintListener listener) { * windowing toolkit that you want touch events to be generated. * </p> * + * @param listener the listener which should be notified + * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the listener is null</li> * </ul> @@ -451,6 +453,7 @@ public void addPaintListener (PaintListener listener) { * * @see TouchListener * @see #removeTouchListener + * * @since 3.7 */ public void addTouchListener (TouchListener listener) { @@ -820,8 +823,11 @@ void enableWidget (boolean enabled) { /** * Returns the accessible object for the receiver. + * <p> * If this is the first time this object is requested, - * then the object is created and returned. + * then the object is created and returned. The object + * returned by getAccessible() does not need to be disposed. + * </p> * * @return the accessible object * @@ -1144,6 +1150,24 @@ public Monitor getMonitor () { } /** + * Returns the orientation of the receiver, which will be one of the + * constants <code>SWT.LEFT_TO_RIGHT</code> or <code>SWT.RIGHT_TO_LEFT</code>. + * + * @return the orientation style + * + * @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> + * + * @since 3.7 + */ +public int getOrientation () { + checkWidget (); + return style & (SWT.LEFT_TO_RIGHT | SWT.RIGHT_TO_LEFT); +} + +/** * Returns the receiver's parent, which must be a <code>Composite</code> * or null when the receiver is a shell that was created with null or * a display for a parent. @@ -2150,7 +2174,7 @@ public void removeFocusListener(FocusListener listener) { /** * Removes the listener from the collection of listeners who will - * be notified when a gesture is performed on the control + * be notified when gesture events are generated for the control. * * @param listener the listener which should no longer be notified * @@ -2164,6 +2188,7 @@ public void removeFocusListener(FocusListener listener) { * * @see GestureListener * @see #addGestureListener + * * @since 3.7 */ public void removeGestureListener (GestureListener listener) { @@ -2391,6 +2416,7 @@ public void removePaintListener(PaintListener listener) { * * @see TouchListener * @see #addTouchListener + * * @since 3.7 */ public void removeTouchListener(TouchListener listener) { @@ -2895,6 +2921,24 @@ public void setMenu (Menu menu) { } /** + * Sets the orientation of the receiver, which must be one + * of the constants <code>SWT.LEFT_TO_RIGHT</code> or <code>SWT.RIGHT_TO_LEFT</code>. + * <p> + * + * @param orientation new orientation style + * + * @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> + * + * @since 3.7 + */ +public void setOrientation (int orientation) { + checkWidget (); +} + +/** * Changes the parent of the widget to be the one provided if * the underlying operating system supports this feature. * Returns <code>true</code> if the parent is successfully changed. @@ -3032,18 +3076,15 @@ public void setSize (int width, int height) { } /** - * Sets the receiver to receive touch events from the OS. By default, touch - * events are not delivered to a control unless specifically requested for that control. - * This is independent of whether or not there are any <code>TouchListener</code> instances - * registered for the control. - * - * @param enabled the new touch-enabled state. - * + * Sets whether the receiver should accept touch events. By default, a Control does not accept touch + * events. No error or exception is thrown if the underlying hardware does not support touch input. + * + * @param enabled the new touch-enabled state + * * @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> - * + * * @since 3.7 */ public void setTouchEnabled(boolean enabled) { diff --git a/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/Display.java b/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/Display.java index 0a848eb693..90e38b2967 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/Display.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/Display.java @@ -804,7 +804,7 @@ public Shell getActiveShell () { * over top of, or null if it is not currently over one of the * controls built by the currently running application. * - * @return the control under the cursor + * @return the control under the cursor or <code>null</code> * * @exception SWTException <ul> * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> @@ -1025,7 +1025,7 @@ public int getDoubleClickTime () { * any of the controls built by the currently running * application. * - * @return the control under the cursor + * @return the focus control or <code>null</code> * * @exception SWTException <ul> * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> @@ -1477,6 +1477,11 @@ public Thread getThread () { /** * Returns true if a touch-aware input device is attached to the system, * enabled, and ready for use. + * + * @exception SWTException <ul> + * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> + * <li>ERROR_DEVICE_DISPOSED - if the receiver has been disposed</li> + * </ul> * * @since 3.7 */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/Menu.java b/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/Menu.java index c54ba7b0b3..caa3c4f915 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/Menu.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/Menu.java @@ -413,6 +413,24 @@ String getNameText () { } /** + * Returns the orientation of the receiver, which will be one of the + * constants <code>SWT.LEFT_TO_RIGHT</code> or <code>SWT.RIGHT_TO_LEFT</code>. + * + * @return the orientation style + * + * @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> + * + * @since 3.7 + */ +public int getOrientation () { + checkWidget (); + return style & (SWT.LEFT_TO_RIGHT | SWT.RIGHT_TO_LEFT); +} + +/** * Returns the receiver's parent, which must be a <code>Decorations</code>. * * @return the receiver's parent @@ -804,6 +822,24 @@ public void setLocation (Point location) { } /** + * Sets the orientation of the receiver, which must be one + * of the constants <code>SWT.LEFT_TO_RIGHT</code> or <code>SWT.RIGHT_TO_LEFT</code>. + * <p> + * + * @param orientation new orientation style + * + * @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> + * + * @since 3.7 + */ +public void setOrientation (int orientation) { + checkWidget (); +} + +/** * Marks the receiver as visible if the argument is <code>true</code>, * and marks it invisible otherwise. * <p> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/Text.java b/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/Text.java index 9a7d1adbb0..846c272cc5 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/Text.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/Text.java @@ -842,6 +842,7 @@ public String getText (int start, int end) { * <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 #setTextChars(char[]) * @since 3.7 */ public char [] getTextChars () { @@ -1551,6 +1552,7 @@ public void setText (String string) { * <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 #getTextChars() * @since 3.7 */ public void setTextChars (char [] text) { diff --git a/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/ToolItem.java b/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/ToolItem.java index 74ea3c3991..4afb3d044c 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/ToolItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/photon/org/eclipse/swt/widgets/ToolItem.java @@ -953,7 +953,14 @@ public void setToolTipText (String string) { /** * Sets the width of the receiver, for <code>SEPARATOR</code> ToolItems. * - * @param width the new width + * @param width the new width. If the new value is <code>SWT.DEFAULT</code>, + * the width is a fixed-width area whose amount is determined by the platform. + * If the new value is 0 a vertical or horizontal line will be drawn, depending + * on the setting of the corresponding style bit (<code>SWT.VERTICAL</code> or + * <code>SWT.HORIZONTAL</code>). If the new value is <code>SWT.SEPARATOR_FILL</code> + * a variable-width space is inserted that acts as a spring between the two adjoining + * items which will push them out to the extent of the containing ToolBar. + * * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |