diff options
author | Andrew John Hughes <gnu_andrew@member.fsf.org> | 2006-03-25 01:46:10 +0000 |
---|---|---|
committer | Andrew John Hughes <gnu_andrew@member.fsf.org> | 2006-03-25 01:46:10 +0000 |
commit | 6e5998c74acb9f802a6429f9647e540d07ce53d5 (patch) | |
tree | 26385df35f2fa67b6a5b2600f617ad515732fdfe /javax | |
parent | d0d52d2affe815851d6e7f83735c66ea889431be (diff) | |
download | classpath-6e5998c74acb9f802a6429f9647e540d07ce53d5.tar.gz |
2006-03-05 Robert Schuster <robertschuster@fsfe.org>
* javax/swing/text/GapContent.java:
(insertString): Throw exception when argument is below
zero.
2006-03-05 David Gilbert <david.gilbert@object-refinery.com>
* javax/swing/filechooser/FileFilter.java:
(accept): Fixed API doc tag,
(getDescription): Likewise,
* javax/swing/filechooser/FileView.java:
(isTraversable): Fixed API doc tag.
2006-03-05 David Gilbert <david.gilbert@object-refinery.com>
* javax/swing/colorchooser/ColorSelectionModel.java: Reformatted and
added API docs all over.
2006-03-05 David Gilbert <david.gilbert@object-refinery.com>
* javax/swing/plaf/ComboBoxUI.java: Fixed typo in class description,
and corrected a bad API doc tag.
2006-03-05 David Gilbert <david.gilbert@object-refinery.com>
* javax/swing/undo/StateEditable.java
(restoreState): Fixed bad API doc tag,
* javax/swing/undo/UndoableEdit.java: Copied API doc comments from
AbstractUndoableEdit.java,
* javax/swing/undo/UndoableEditSupport.java
(createCompoundEdit): Fixed bad API doc tag,
* javax/swing/undo/UndoManager.java
(editToBeUndone): Fixed bad API doc tag,
(editToBeRedone): Likewise.
2006-03-05 David Gilbert <david.gilbert@object-refinery.com>
* javax/swing/DefaultFocusManager.java: Fixed bad API doc tags,
* javax/swing/FocusManager.java: Likewise.
2006-03-05 David Gilbert <david.gilbert@object-refinery.com>
* javax/swing/plaf/metal/MetalComboBoxButton.java
(MetalComboBoxButton(JComboBox, Icon, boolean, CellRendererPane,
JList)): Fixed API doc tag,
* javax/swing/plaf/metal/MetalInternalFrameTitlePane
(createLayout): Fixed API doc warning.
2006-03-05 Tom Tromey <tromey@redhat.com>
* vm/reference/java/lang/reflect/Constructor.java (toString): Use
ClassHelper.getUserName.
* vm/reference/java/lang/reflect/Method.java (toString): Use
ClassHelper.getUserName.
(getUserTypeName): Removed.
* gnu/java/lang/ClassHelper.java (getUserName): New method.
* vm/reference/java/lang/reflect/Field.java (toString): Use
ClassHelper.getUserName.
2006-03-05 Olivier Jolly <olivier.jolly@pcedev.com>
Fixes PR 22813
* java/net/URLClassLoader.java (FileURLLoader.getResource):
Allows directories as valid resources.
Diffstat (limited to 'javax')
-rw-r--r-- | javax/swing/DefaultFocusManager.java | 31 | ||||
-rw-r--r-- | javax/swing/FocusManager.java | 2 | ||||
-rw-r--r-- | javax/swing/colorchooser/ColorSelectionModel.java | 75 | ||||
-rw-r--r-- | javax/swing/filechooser/FileFilter.java | 6 | ||||
-rw-r--r-- | javax/swing/filechooser/FileView.java | 4 | ||||
-rw-r--r-- | javax/swing/plaf/ComboBoxUI.java | 14 | ||||
-rw-r--r-- | javax/swing/plaf/metal/MetalComboBoxButton.java | 2 | ||||
-rw-r--r-- | javax/swing/plaf/metal/MetalInternalFrameTitlePane.java | 5 | ||||
-rw-r--r-- | javax/swing/undo/StateEditable.java | 8 | ||||
-rw-r--r-- | javax/swing/undo/UndoManager.java | 8 | ||||
-rw-r--r-- | javax/swing/undo/UndoableEdit.java | 191 | ||||
-rw-r--r-- | javax/swing/undo/UndoableEditSupport.java | 4 |
12 files changed, 198 insertions, 152 deletions
diff --git a/javax/swing/DefaultFocusManager.java b/javax/swing/DefaultFocusManager.java index 08db65168..103a7f36c 100644 --- a/javax/swing/DefaultFocusManager.java +++ b/javax/swing/DefaultFocusManager.java @@ -1,5 +1,5 @@ /* DefaultFocusManager.java -- - Copyright (C) 2002, 2004 Free Software Foundation, Inc. + Copyright (C) 2002, 2004, 2006, Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -49,9 +49,10 @@ import java.util.Stack; * * @author Andrew Selkirk */ -public class DefaultFocusManager extends FocusManager { +public class DefaultFocusManager extends FocusManager +{ - /** + /** * historyStack */ private Stack historyStack; @@ -77,7 +78,7 @@ public class DefaultFocusManager extends FocusManager { // TODO } // processKeyEvent() - /** + /** * focusNextComponent * * @param component @@ -88,7 +89,7 @@ public class DefaultFocusManager extends FocusManager { // TODO } // focusNextComponent() - /** + /** * focusPreviousComponent * * @param component @@ -99,66 +100,66 @@ public class DefaultFocusManager extends FocusManager { // TODO } // focusPreviousComponent() - /** + /** * getFirstComponent * * @param container * TODO - * @returns Component + * @return Component */ public Component getFirstComponent(Container container) { return null; // TODO } // getFirstComponent() - /** + /** * getLastComponent * * @param container * TODO - * @returns Component + * @return Component */ public Component getLastComponent(Container container) { return null; // TODO } // getLastComponent() - /** + /** * getComponentBefore * * @param container * TODO * @param component * TODO - * @returns Component + * @return Component */ public Component getComponentBefore(Container container, Component component) { return null; // TODO } // getComponentBefore() - /** + /** * getComponentAfter * * @param container * TODO * @param component * TODO - * @returns Component + * @return Component */ public Component getComponentAfter(Container container, Component component) { return null; // TODO } // getComponentAfter() - /** + /** * compareTabOrder * * @param component1 * TODO * @param component2 * TODO - * @returns boolean + * @return boolean */ public boolean compareTabOrder(Component component1, Component component2) { diff --git a/javax/swing/FocusManager.java b/javax/swing/FocusManager.java index a2109ee06..21e4482d1 100644 --- a/javax/swing/FocusManager.java +++ b/javax/swing/FocusManager.java @@ -485,7 +485,7 @@ public abstract class FocusManager /** * getCurrentManager - * @returns FocusManager + * @return FocusManager */ public static FocusManager getCurrentManager() { diff --git a/javax/swing/colorchooser/ColorSelectionModel.java b/javax/swing/colorchooser/ColorSelectionModel.java index 5f3070813..b660505fc 100644 --- a/javax/swing/colorchooser/ColorSelectionModel.java +++ b/javax/swing/colorchooser/ColorSelectionModel.java @@ -1,5 +1,5 @@ /* ColorSelectionModel.java -- - Copyright (C) 2002, 2004 Free Software Foundation, Inc. + Copyright (C) 2002, 2004, 2006, Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -40,42 +40,47 @@ package javax.swing.colorchooser; import java.awt.Color; +import javax.swing.JColorChooser; +import javax.swing.event.ChangeEvent; import javax.swing.event.ChangeListener; /** - * ColorSelectionModel + * A model that is used by the {@link JColorChooser} component to represent the + * selected color. + * * @author Andrew Selkirk - * @version 1.0 */ -public interface ColorSelectionModel { - - //------------------------------------------------------------- - // Methods ---------------------------------------------------- - //------------------------------------------------------------- - - /** - * getSelectedColor - * @returns Color - */ - Color getSelectedColor(); - - /** - * setSelectedColor - * @param color TODO - */ - void setSelectedColor(Color color); - - /** - * addChangeListener - * @param listener TODO - */ - void addChangeListener(ChangeListener listener); - - /** - * removeChangeListener - * @param listener TODO - */ - void removeChangeListener(ChangeListener listener); - - -} // ColorSelectionModel +public interface ColorSelectionModel +{ + + /** + * Returns the selected color. + * + * @return The selected color. + */ + Color getSelectedColor(); + + /** + * Sets the selected color. + * + * @param color the selected color. + */ + void setSelectedColor(Color color); + + /** + * Registers a listener to receive {@link ChangeEvent} notifications + * from this model. + * + * @param listener the listener. + */ + void addChangeListener(ChangeListener listener); + + /** + * Deregisters a listener so that it no longer receives {@link ChangeEvent} + * notifications from this action. + * + * @param listener the listener. + */ + void removeChangeListener(ChangeListener listener); + +} diff --git a/javax/swing/filechooser/FileFilter.java b/javax/swing/filechooser/FileFilter.java index ecfa54b58..de11525a2 100644 --- a/javax/swing/filechooser/FileFilter.java +++ b/javax/swing/filechooser/FileFilter.java @@ -1,5 +1,5 @@ /* FileFilter.java -- - Copyright (C) 2002, 2005 Free Software Foundation, Inc. + Copyright (C) 2002, 2005, 2006, Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -67,7 +67,7 @@ public abstract class FileFilter * * @param file the file. * - * @returns A boolean. + * @return A boolean. */ public abstract boolean accept(File file); @@ -78,7 +78,7 @@ public abstract class FileFilter * is used to select the appropriate filter (in cases where more than one * filter is available). * - * @returns A description of the filter. + * @return A description of the filter. */ public abstract String getDescription(); diff --git a/javax/swing/filechooser/FileView.java b/javax/swing/filechooser/FileView.java index ea1989f93..8c2be32ef 100644 --- a/javax/swing/filechooser/FileView.java +++ b/javax/swing/filechooser/FileView.java @@ -1,5 +1,5 @@ /* FileView.java -- - Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc. + Copyright (C) 2002, 2004, 2005, 2006, Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -118,7 +118,7 @@ public abstract class FileView * * @param directory the directory. * - * @returns Always <code>null</code>. + * @return Always <code>null</code>. */ public Boolean isTraversable(File directory) { diff --git a/javax/swing/plaf/ComboBoxUI.java b/javax/swing/plaf/ComboBoxUI.java index 3e81ed75a..58f6e815c 100644 --- a/javax/swing/plaf/ComboBoxUI.java +++ b/javax/swing/plaf/ComboBoxUI.java @@ -1,5 +1,5 @@ /* ComboBoxUI.java -- - Copyright (C) 2002, 2003 Free Software Foundation, Inc. + Copyright (C) 2002, 2003, 2006, Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -41,9 +41,7 @@ import javax.swing.JComboBox; /** * An abstract base class for delegates that implement the pluggable - * look and feel for a <code>JButton</code>. - * - * @see javax.swing.JComboBox + * look and feel for a {@link JComboBox}. * * @author Andrew Selkirk * @author Sascha Brawer (brawer@dandelis.ch) @@ -57,8 +55,7 @@ public abstract class ComboBoxUI extends ComponentUI { // Nothing to do here. } - - + /** * Sets the visibility of the popup button. * @@ -70,7 +67,6 @@ public abstract class ComboBoxUI extends ComponentUI */ public abstract void setPopupVisible(JComboBox c, boolean visible); - /** * Determines whether the popup button is currently visible. * @@ -82,15 +78,15 @@ public abstract class ComboBoxUI extends ComponentUI */ public abstract boolean isPopupVisible(JComboBox c); - /** * Determines whether the combo box can receive input focus. * * @param c <code>JComboBox</code> whose focus traversability * is to be retrieved. * - * @returns <code>true</code> if <code>c</code> can receive + * @return <code>true</code> if <code>c</code> can receive * input focus, <code>false</code> otherwise. */ public abstract boolean isFocusTraversable(JComboBox c); + } diff --git a/javax/swing/plaf/metal/MetalComboBoxButton.java b/javax/swing/plaf/metal/MetalComboBoxButton.java index 6993e18e9..67a100f16 100644 --- a/javax/swing/plaf/metal/MetalComboBoxButton.java +++ b/javax/swing/plaf/metal/MetalComboBoxButton.java @@ -91,7 +91,7 @@ public class MetalComboBoxButton extends JButton { * @param cb the combo that the button is used for (<code>null</code> not * permitted). * @param i the icon displayed on the button. - * @parma onlyIcon a flag that specifies whether the button displays only an + * @param onlyIcon a flag that specifies whether the button displays only an * icon, or text as well. * @param pane the rendering pane. * @param list the list. diff --git a/javax/swing/plaf/metal/MetalInternalFrameTitlePane.java b/javax/swing/plaf/metal/MetalInternalFrameTitlePane.java index 2cf5f67d5..534f0ca34 100644 --- a/javax/swing/plaf/metal/MetalInternalFrameTitlePane.java +++ b/javax/swing/plaf/metal/MetalInternalFrameTitlePane.java @@ -329,9 +329,10 @@ public class MetalInternalFrameTitlePane extends BasicInternalFrameTitlePane } /** - * Creates a new instance of {@link MetalTitlePaneLayout}. + * Creates a new instance of <code>MetalTitlePaneLayout</code> (not part of + * the public API). * - * @return A new instance of {@link MetalTitlePaneLayout}. + * @return A new instance of <code>MetalTitlePaneLayout</code>. */ protected LayoutManager createLayout() { diff --git a/javax/swing/undo/StateEditable.java b/javax/swing/undo/StateEditable.java index 3b9ac6c18..7e6cc9785 100644 --- a/javax/swing/undo/StateEditable.java +++ b/javax/swing/undo/StateEditable.java @@ -1,5 +1,5 @@ /* StateEditable.java -- Interface for collaborating with StateEdit. - Copyright (C) 2002, 2003 Free Software Foundation, Inc. + Copyright (C) 2002, 2003, 2006, Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -90,9 +90,9 @@ public interface StateEditable * from the specified hash table. * * <p><b>Note to implementors of this interface:</b> To increase - * efficiency, the <code>StateEdit</code> class {@linkplan - * StateEdit#removeRedundantState() removes redundant state - * information}. Therefore, implementations of this interface must be + * efficiency, the <code>StateEdit</code> class {@link + * StateEdit#removeRedundantState()} removes redundant state + * information. Therefore, implementations of this interface must be * prepared for the case where certain keys were stored into the * table by {@link #storeState}, but are not present anymore * when the <code>restoreState</code> method gets called. diff --git a/javax/swing/undo/UndoManager.java b/javax/swing/undo/UndoManager.java index 565b5ca88..b9e6de675 100644 --- a/javax/swing/undo/UndoManager.java +++ b/javax/swing/undo/UndoManager.java @@ -1,5 +1,5 @@ -/* AbstractTableModel.java -- - Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc. +/* UndoManager.java -- + Copyright (C) 2002, 2004, 2005, 2006, Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -265,7 +265,7 @@ public class UndoManager * Determines which significant edit would be undone if {@link * #undo()} was called. * - * @returns the significant edit that would be undone, or + * @return the significant edit that would be undone, or * <code>null</code> if no significant edit would be affected by * calling {@link #undo()}. */ @@ -288,7 +288,7 @@ public class UndoManager * Determines which significant edit would be redone if {@link * #redo()} was called. * - * @returns the significant edit that would be redone, or + * @return the significant edit that would be redone, or * <code>null</code> if no significant edit would be affected by * calling {@link #redo()}. */ diff --git a/javax/swing/undo/UndoableEdit.java b/javax/swing/undo/UndoableEdit.java index 982d7f2a7..9938af751 100644 --- a/javax/swing/undo/UndoableEdit.java +++ b/javax/swing/undo/UndoableEdit.java @@ -1,5 +1,5 @@ -/* AbstractTableModel.java -- - Copyright (C) 2002 Free Software Foundation, Inc. +/* UndoableEdit.java -- + Copyright (C) 2002, 2006, Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -38,77 +38,120 @@ exception statement from your version. */ package javax.swing.undo; /** - * UndoableEdit public interface + * An editing operation that supports undo/redoability. + * * @author Andrew Selkirk */ -public interface UndoableEdit { - - /** - * anEdit - * @param anEdit TODO - * @returns TODO - */ - boolean addEdit(UndoableEdit anEdit); - - /** - * canRedo - * @returns TODO - */ - boolean canRedo(); - - /** - * canRedo - * @returns TODO - */ - boolean canUndo(); - - /** - * die - */ - void die(); - - /** - * getPresentationName - * @returns TODO - */ - String getPresentationName(); - - /** - * getRedoPresentationName - * @returns TODO - */ - String getRedoPresentationName(); - - /** - * getUndoPresentationName - * @returns TODO - */ - String getUndoPresentationName(); - - /** - * isSignificant - * @returns TODO - */ - boolean isSignificant(); - - /** - * redo - * @throws CannotRedoException TODO - */ - void redo() throws CannotRedoException; - - /** - * replaceEdit - * @param anEdit TODO - * @returns TODO - */ - boolean replaceEdit(UndoableEdit anEdit); - - /** - * undo - * @throws CannotUndoException TODO - */ - void undo() throws CannotUndoException; - - -} // UndoableEdit +public interface UndoableEdit +{ + + /** + * Incorporates another editing action into this one, thus forming a + * combined action. + * + * @param edit the editing action to be incorporated. + * + * @return <code>true</code> if the edit was combined successfully, and + * <code>false</code> if it could not be combined. + */ + boolean addEdit(UndoableEdit edit); + + /** + * Determines whether it would be possible to redo this editing + * action. + * + * @return <code>true</code> to indicate that this action can be + * redone, <code>false</code> otherwise. + * + * @see #redo() + * @see #canUndo() + */ + boolean canRedo(); + + /** + * Determines whether it would be possible to undo this editing + * action. + * + * @return <code>true</code> to indicate that this action can be + * undone, <code>false</code> otherwise. + * + * @see #undo() + * @see #canRedo() + */ + boolean canUndo(); + + /** + * Informs this edit action that it will no longer be used. Some + * actions might use this information to release resources, for + * example open files. Called by {@link UndoManager} before this + * action is removed from the edit queue. + */ + void die(); + + /** + * Returns a human-readable, localized name that describes this + * editing action and can be displayed to the user. + * + * @return The presentation name. + */ + String getPresentationName(); + + /** + * Returns the redo presentation name. + * + * @return The redo presentation name. + */ + String getRedoPresentationName(); + + /** + * Returns the undo presentation name. + * + * @return The undo presentation name. + */ + String getUndoPresentationName(); + + /** + * Determines whether this editing action is significant enough for + * being seperately undoable by the user. A typical significant + * action would be the resizing of an object. However, changing the + * selection in a text document would usually not be considered + * significant. + * + * @return <code>true</code> to indicate that the action is + * significant enough for being separately undoable, or + * <code>false</code> otherwise. + */ + boolean isSignificant(); + + /** + * Redoes this editing action. + * + * @throws CannotRedoException if the edit cannot be undone. + * + * @see #canRedo() + * @see #undo() + */ + void redo() throws CannotRedoException; + + /** + * Incorporates another editing action into this one, thus forming a + * combined action that replaces the argument action. + * + * @param edit the editing action to be replaced. + * + * @return <code>true</code> if the edit is successfully replaced, and + * <code>false</code> otherwise. + */ + boolean replaceEdit(UndoableEdit edit); + + /** + * Undoes this editing action. + * + * @throws CannotUndoException if the edit cannot be undone. + * + * @see #canUndo() + * @see #redo() + */ + void undo() throws CannotUndoException; + +} diff --git a/javax/swing/undo/UndoableEditSupport.java b/javax/swing/undo/UndoableEditSupport.java index 26fcd0bc5..b5a933419 100644 --- a/javax/swing/undo/UndoableEditSupport.java +++ b/javax/swing/undo/UndoableEditSupport.java @@ -1,5 +1,5 @@ /* UndoableEditSupport.java -- - Copyright (C) 2002, 2003, 2004, 2005 Free Software Foundation, Inc. + Copyright (C) 2002, 2003, 2004, 2005, 2006, Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -239,7 +239,7 @@ public class UndoableEditSupport * on a specific {@link #compoundEdit}, it should override this * method. * - * @returns a newly created instance of {@link CompoundEdit}. + * @return a newly created instance of {@link CompoundEdit}. */ protected CompoundEdit createCompoundEdit() { |