I added and fixed some class descriptions.
2005-09-05 Roman Kennke <[EMAIL PROTECTED]>
* javax/swing/JDesktopPane.java: Fixed typo in class
description.
* javax/swing/JEditorPane.java: Removed unneeded import.
Added class description.
* javax/swing/JDialog.java: Made class description more useful.
* javax/swing/JFileChooser.java: Added class description.
* javax/swing/JFormattedTextField.java: Added class description.
(AbstractFormatter): Likewise.
(AbstractFormatterFactory): Likewise.
* javax/swing/JFrame.java: Made class description more useful.
/Roman
Index: javax/swing/JDesktopPane.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/JDesktopPane.java,v
retrieving revision 1.10
diff -u -r1.10 JDesktopPane.java
--- javax/swing/JDesktopPane.java 2 Jul 2005 20:32:47 -0000 1.10
+++ javax/swing/JDesktopPane.java 5 Sep 2005 13:59:25 -0000
@@ -48,7 +48,7 @@
/**
* JDesktopPane is a container (usually for JInternalFrames) that simulates a
- * desktop. Typically, the user will create JInternalFrames and place thme in
+ * desktop. Typically, the user will create JInternalFrames and place them in
* a JDesktopPane. The user can then interact with JInternalFrames like they
* usually would with JFrames. The actions (minimize, maximize, close, etc)
* are done by using a DesktopManager that is associated with the
Index: javax/swing/JEditorPane.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/JEditorPane.java,v
retrieving revision 1.20
diff -u -r1.20 JEditorPane.java
--- javax/swing/JEditorPane.java 2 Jul 2005 20:32:47 -0000 1.20
+++ javax/swing/JEditorPane.java 5 Sep 2005 13:59:25 -0000
@@ -39,7 +39,6 @@
package javax.swing;
import java.awt.Dimension;
-import java.awt.event.KeyEvent;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
@@ -52,7 +51,29 @@
import javax.swing.text.EditorKit;
import javax.swing.text.JTextComponent;
-
+/**
+ * A powerful text editor component that can handle different types of
+ * content.
+ *
+ * The JEditorPane text component is driven by an instance of
+ * [EMAIL PROTECTED] EditorKit}. The editor kit is responsible for providing
+ * a default [EMAIL PROTECTED] Document} implementation, a mechanism for loading
+ * and saving documents of its supported content type and providing
+ * a set of [EMAIL PROTECTED] Action}s for manipulating the content.
+ *
+ * By default the following content types are supported:
+ * <ul>
+ * <li><code>text/plain</code>: Plain text, handled by
+ * [EMAIL PROTECTED] javax.swing.text.DefaultEditorKit}.</li>
+ * <li><code>text/html</code>: HTML 4.0 styled text, handled by
+ * [EMAIL PROTECTED] javax.swing.text.html.HTMLEditorKit}.</li>
+ * <li><code>text/rtf</code>: RTF text, handled by
+ * [EMAIL PROTECTED] javax.swing.text.rtf.RTFEditorKit}.</li>
+ * </ul>
+ *
+ * @author original author unknown
+ * @author Roman Kennke ([EMAIL PROTECTED])
+ */
public class JEditorPane extends JTextComponent
{
private static final long serialVersionUID = 3140472492599046285L;
Index: javax/swing/JDialog.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/JDialog.java,v
retrieving revision 1.16
diff -u -r1.16 JDialog.java
--- javax/swing/JDialog.java 12 Jul 2005 13:48:35 -0000 1.16
+++ javax/swing/JDialog.java 5 Sep 2005 13:59:25 -0000
@@ -53,10 +53,15 @@
import javax.accessibility.AccessibleContext;
/**
- * Unlike JComponent derivatives, JDialog inherits from java.awt.Dialog. But
- * also lets a look-and-feel component to its work.
+ * A dialog window. This is an extension of [EMAIL PROTECTED] java.awt.Dialog} that
+ * provides support for the Swing architecture. Most importantly it contains a
+ * [EMAIL PROTECTED] JRootPane} as it's only top-level child, that manages the content
+ * pane, the menu and a glass pane.
*
- * @author Ronald Veldema (rveldema_AT_cs.vu.nl)
+ * Also, unlike <code>java.awt.Dialog</code>s, JDialogs support the
+ * Swing Pluggable Look & Feel architecture.
+ *
+ * @author Ronald Veldema ([EMAIL PROTECTED])
*/
public class JDialog extends Dialog implements Accessible, WindowConstants,
RootPaneContainer
Index: javax/swing/JFileChooser.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/JFileChooser.java,v
retrieving revision 1.14
diff -u -r1.14 JFileChooser.java
--- javax/swing/JFileChooser.java 31 Aug 2005 19:18:49 -0000 1.14
+++ javax/swing/JFileChooser.java 5 Sep 2005 13:59:25 -0000
@@ -54,7 +54,17 @@
/**
- * DOCUMENT ME!
+ * A component that provides the user a dialog box to browse through a
+ * filesystem and choose one or more files or directories.
+ *
+ * A JFileChooser can be configured to filter the displayed file list
+ * by adding a [EMAIL PROTECTED] FileFilter} instance using
+ * [EMAIL PROTECTED] #addChoosableFileFilter(FileFilter)}. Additional components can
+ * be embedded in the file chooser using [EMAIL PROTECTED] #setAccessory(JComponent)}.
+ * The JFileChooser properties also provide mechanisms to customize the
+ * behaviour of the file chooser.
+ *
+ * @author Kim Ho ([EMAIL PROTECTED])
*/
public class JFileChooser extends JComponent implements Accessible
{
Index: javax/swing/JFormattedTextField.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/JFormattedTextField.java,v
retrieving revision 1.16
diff -u -r1.16 JFormattedTextField.java
--- javax/swing/JFormattedTextField.java 2 Jul 2005 20:32:47 -0000 1.16
+++ javax/swing/JFormattedTextField.java 5 Sep 2005 13:59:25 -0000
@@ -51,13 +51,29 @@
import javax.swing.text.NavigationFilter;
/**
+ * A text field that makes use of a formatter to display and edit a specific
+ * type of data. The value that is displayed can be an arbitrary object. The
+ * formatter is responsible for displaying the value in a textual form and
+ * it may allow editing of the value.
+ *
+ * Formatters are usually obtained using an instance of
+ * [EMAIL PROTECTED] AbstractFormatterFactory}. This factory is responsible for providing
+ * an instance of [EMAIL PROTECTED] AbstractFormatter} that is able to handle the
+ * formatting of the value of the JFormattedTextField.
+ *
* @author Michael Koch
+ *
* @since 1.4
*/
public class JFormattedTextField extends JTextField
{
private static final long serialVersionUID = 5464657870110180632L;
+ /**
+ * An abstract base implementation for a formatter that can be used by
+ * a JTextField. A formatter can display a specific type of object and
+ * may provide a way to edit this value.
+ */
public abstract static class AbstractFormatter implements Serializable
{
private static final long serialVersionUID = -5193212041738979680L;
@@ -124,7 +140,11 @@
public abstract String valueToString (Object value)
throws ParseException;
}
-
+
+ /**
+ * Delivers instances of an [EMAIL PROTECTED] AbstractFormatter} for
+ * a specific value type for a JFormattedTextField.
+ */
public abstract static class AbstractFormatterFactory
{
public AbstractFormatterFactory ()
Index: javax/swing/JFrame.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/JFrame.java,v
retrieving revision 1.27
diff -u -r1.27 JFrame.java
--- javax/swing/JFrame.java 21 Jul 2005 14:59:31 -0000 1.27
+++ javax/swing/JFrame.java 5 Sep 2005 13:59:25 -0000
@@ -53,9 +53,15 @@
import javax.accessibility.AccessibleContext;
/**
- * Unlike JComponent derivatives, JFrame inherits from
- * java.awt.Frame. But also lets a look-and-feel component to its work.
+ * A window that supports window decorations (titlebar and borders).
+ * This is an extension of [EMAIL PROTECTED] java.awt.Frame} that provides support
+ * for the Swing architecture. Most importantly it contains a [EMAIL PROTECTED] JRootPane}
+ * as it's only top-level child, that manages the content pane, the menu and
+ * a glass pane.
*
+ * Also, unlike <code>java.awt.Frame</code>s, JFrames support the
+ * Swing Pluggable Look & Feel architecture.
+ *
* @author Ronald Veldema ([EMAIL PROTECTED])
*/
public class JFrame extends Frame
_______________________________________________
Classpath-patches mailing list
[email protected]
http://lists.gnu.org/mailman/listinfo/classpath-patches
