Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCarolyn MacLeod2004-05-11 07:57:52 +0000
committerCarolyn MacLeod2004-05-11 07:57:52 +0000
commit524d79ea9ecd8197dab8f8d1b2841285c04ec9f7 (patch)
tree30c7b8e86d504488a801c042869ad6fcbad6dcb6 /bundles/org.eclipse.swt/Eclipse SWT AWT/emulated
parentf429db6e57773ce96e34f2fa05fa073db3cdc6c7 (diff)
downloadeclipse.platform.swt-524d79ea9ecd8197dab8f8d1b2841285c04ec9f7.tar.gz
eclipse.platform.swt-524d79ea9ecd8197dab8f8d1b2841285c04ec9f7.tar.xz
eclipse.platform.swt-524d79ea9ecd8197dab8f8d1b2841285c04ec9f7.zip
Javadoc Basher output pre M9AFTER_JAVADOC_BASH_FOR_30M9
Diffstat (limited to 'bundles/org.eclipse.swt/Eclipse SWT AWT/emulated')
-rw-r--r--bundles/org.eclipse.swt/Eclipse SWT AWT/emulated/org/eclipse/swt/awt/SWT_AWT.java41
1 files changed, 41 insertions, 0 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT AWT/emulated/org/eclipse/swt/awt/SWT_AWT.java b/bundles/org.eclipse.swt/Eclipse SWT AWT/emulated/org/eclipse/swt/awt/SWT_AWT.java
index 9df1cec987..7bbf8f5da6 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT AWT/emulated/org/eclipse/swt/awt/SWT_AWT.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT AWT/emulated/org/eclipse/swt/awt/SWT_AWT.java
@@ -18,10 +18,36 @@ import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;
+/**
+ * This class provides a bridge between SWT and AWT, so that it
+ * is possible to embedded AWT components in SWT and vice versa.
+ *
+ * @since 3.0
+ */
public class SWT_AWT {
+ /**
+ * The name of the embedded Frame class. The default class name
+ * for the platform will be used if <code>null</code>.
+ */
public static String embeddedFrameClass;
+/**
+ * Creates a new <code>java.awt.Frame</code>. This frame is the root for
+ * the AWT components that will be embedded within the composite. In order
+ * for the embedding to succeed, the composite must have been created
+ * with the SWT.EMBEDDED style.
+ *
+ * @param parent the parent <code>Composite</code> of the new <code>java.awt.Frame</code>
+ * @return a <code>java.awt.Frame</code> to be the parent of the embedded AWT components
+ *
+ * @exception IllegalArgumentException <ul>
+ * <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
+ * <li>ERROR_INVALID_ARGUMENT - if the parent Composite does not have the SWT.EMBEDDED style</li>
+ * </ul>
+ *
+ * @since 3.0
+ */
public static Frame new_Frame (final Composite parent) {
if (parent == null) SWT.error (SWT.ERROR_NULL_ARGUMENT);
if ((parent.getStyle () & SWT.EMBEDDED) == 0) {
@@ -31,6 +57,21 @@ public static Frame new_Frame (final Composite parent) {
return null;
}
+/**
+ * Creates a new <code>Shell</code>. This Shell is the root for
+ * the SWT widgets that will be embedded within the AWT canvas.
+ *
+ * @param display the display for the new Shell
+ * @param parent the parent <code>java.awt.Canvas</code> of the new Shell
+ * @return a <code>Shell</code> to be the parent of the embedded SWT widgets
+ *
+ * @exception IllegalArgumentException <ul>
+ * <li>ERROR_NULL_ARGUMENT - if the display is null</li>
+ * <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
+ * </ul>
+ *
+ * @since 3.0
+ */
public static Shell new_Shell (final Display display, final Canvas parent) {
if (display == null) SWT.error (SWT.ERROR_NULL_ARGUMENT);
if (parent == null) SWT.error (SWT.ERROR_NULL_ARGUMENT);

Back to the top