stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8076520: Fix missing doclint warnings in javax.swing.{table, tree, undo, plaf.{metal, nimbus, synth}}

Browse Source 
Reviewed-by: alexsch
This commit is contained in:
Joe Darcy 2015-04-03 10:41:34 -07:00
parent 9f1092391e
commit a9992adde7
19 changed files with 106 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
jdk/src/java.desktop/share/classes/javax/swing/plaf/metal/MetalFileChooserUI.java
View File

@ -569,7 +569,9 @@ public class MetalFileChooserUI extends BasicFileChooserUI {
return super.createListSelectionListener(fc);
}
// Obsolete class, not used in this version.
/**
* Obsolete class, not used in this version.
*/
protected class SingleClickListener extends MouseAdapter {
/**
* Constructs an instance of {@code SingleClickListener}.
@ -580,7 +582,9 @@ public class MetalFileChooserUI extends BasicFileChooserUI {
}
}
// Obsolete class, not used in this version.
/**
* Obsolete class, not used in this version.
*/
@SuppressWarnings("serial") // Superclass is not serializable across versions
protected class FileRenderer extends DefaultListCellRenderer {
}

12
jdk/src/java.desktop/share/classes/javax/swing/plaf/nimbus/AbstractRegionPainter.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -495,8 +495,16 @@ public abstract class AbstractRegionPainter implements Painter<JComponent> {
* control points and bezier curve anchors.
*/
protected static class PaintContext {
/**
* Cache mode.
*/
protected static enum CacheMode {
NO_CACHING, FIXED_SIZES, NINE_SQUARE_SCALE
/** No caching.*/
NO_CACHING,
/** Fixed sizes.*/
FIXED_SIZES,
/** Nine square scale.*/
NINE_SQUARE_SCALE
}
private static Insets EMPTY_INSETS = new Insets(0, 0, 0, 0);

8
jdk/src/java.desktop/share/classes/javax/swing/plaf/nimbus/NimbusStyle.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -120,11 +120,17 @@ import java.util.TreeMap;
*/
public final class NimbusStyle extends SynthStyle {
/* Keys and scales for large/small/mini components, based on Apples sizes */
/** Large key */
public static final String LARGE_KEY = "large";
/** Small key */
public static final String SMALL_KEY = "small";
/** Mini key */
public static final String MINI_KEY = "mini";
/** Large scale */
public static final double LARGE_SCALE = 1.15;
/** Small scale */
public static final double SMALL_SCALE = 0.857;
/** Mini scale */
public static final double MINI_SCALE = 0.714;
/**

6
jdk/src/java.desktop/share/classes/javax/swing/plaf/synth/SynthInternalFrameUI.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2002, 2013, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2002, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -56,6 +56,10 @@ public class SynthInternalFrameUI extends BasicInternalFrameUI
return new SynthInternalFrameUI((JInternalFrame)b);
}
/**
* Constructs a {@code SynthInternalFrameUI}.
* @param b an internal frame
*/
protected SynthInternalFrameUI(JInternalFrame b) {
super(b);
}

7
jdk/src/java.desktop/share/classes/javax/swing/plaf/synth/SynthScrollBarUI.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2002, 2014, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2002, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -48,6 +48,11 @@ public class SynthScrollBarUI extends BasicScrollBarUI
private boolean validMinimumThumbSize;
/**
* Returns a UI.
* @return a UI
* @param c a component
*/
public static ComponentUI createUI(JComponent c) {
return new SynthScrollBarUI();
}

6
jdk/src/java.desktop/share/classes/javax/swing/plaf/synth/SynthSliderUI.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2002, 2014, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2002, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -93,6 +93,10 @@ public class SynthSliderUI extends BasicSliderUI
return new SynthSliderUI((JSlider)c);
}
/**
* Constructs a {@code SynthSliderUI}.
* @param c a slider
*/
protected SynthSliderUI(JSlider c) {
super(c);
}

7
jdk/src/java.desktop/share/classes/javax/swing/table/AbstractTableModel.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -320,9 +320,8 @@ public abstract class AbstractTableModel implements TableModel, Serializable
*
* If no such listeners exist, this method returns an empty array.
*
* @param listenerType the type of listeners requested; this parameter
* should specify an interface that descends from
* <code>java.util.EventListener</code>
* @param <T> the listener type
* @param listenerType the type of listeners requested
* @return an array of all objects registered as
* <code><em>Foo</em>Listener</code>s on this component,
* or an empty array if no such

5
jdk/src/java.desktop/share/classes/javax/swing/table/DefaultTableCellRenderer.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1998, 2014, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1998, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -95,6 +95,9 @@ public class DefaultTableCellRenderer extends JLabel
*/
private static final Border SAFE_NO_FOCUS_BORDER = new EmptyBorder(1, 1, 1, 1);
private static final Border DEFAULT_NO_FOCUS_BORDER = new EmptyBorder(1, 1, 1, 1);
/**
* A border without focus.
*/
protected static Border noFocusBorder = DEFAULT_NO_FOCUS_BORDER;
// We need a place to store the color the JLabel should be returned

7
jdk/src/java.desktop/share/classes/javax/swing/table/DefaultTableColumnModel.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -652,9 +652,8 @@ public class DefaultTableColumnModel implements TableColumnModel,
*
* If no such listeners exist, this method returns an empty array.
*
* @param listenerType the type of listeners requested; this parameter
* should specify an interface that descends from
* <code>java.util.EventListener</code>
* @param <T> the listener type
* @param listenerType the type of listeners requested
* @return an array of all objects registered as
* <code><em>Foo</em>Listener</code>s on this model,
* or an empty array if no such

10
jdk/src/java.desktop/share/classes/javax/swing/table/DefaultTableModel.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -314,15 +314,7 @@ public class DefaultTableModel extends AbstractTableModel implements Serializabl
/**
* Obsolete as of Java 2 platform v1.3. Please use <code>setRowCount</code> instead.
*/
/*
* Sets the number of rows in the model. If the new size is greater
* than the current size, new rows are added to the end of the model
* If the new size is less than the current size, all
* rows at index <code>rowCount</code> and greater are discarded.
*
* @param rowCount the new number of rows
* @see #setRowCount
*/
public void setNumRows(int rowCount) {
int old = getRowCount();

20
jdk/src/java.desktop/share/classes/javax/swing/table/JTableHeader.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -281,14 +281,8 @@ public class JTableHeader extends JComponent implements TableColumnModelListener
/**
* Obsolete as of Java 2 platform v1.3. Real time repaints, in response to
* column dragging or resizing, are now unconditional.
*/
/*
* Sets whether the body of the table updates in real time when
* a column is resized or dragged.
*
* @param flag true if tableView should update
* the body of the table in real time
* @see #getUpdateTableInRealTime
* @param flag true if tableView should update the body of the
* table in real time
*/
public void setUpdateTableInRealTime(boolean flag) {
updateTableInRealTime = flag;
@ -297,15 +291,7 @@ public class JTableHeader extends JComponent implements TableColumnModelListener
/**
* Obsolete as of Java 2 platform v1.3. Real time repaints, in response to
* column dragging or resizing, are now unconditional.
*/
/*
* Returns true if the body of the table view updates in real
* time when a column is resized or dragged. User can set this flag to
* false to speed up the table's response to user resize or drag actions.
* The default is true.
*
* @return true if the table updates in real time
* @see #setUpdateTableInRealTime
*/
public boolean getUpdateTableInRealTime() {
return updateTableInRealTime;

14
jdk/src/java.desktop/share/classes/javax/swing/tree/DefaultTreeCellEditor.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1998, 2014, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1998, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -477,6 +477,15 @@ public class DefaultTreeCellEditor implements ActionListener, TreeCellEditor,
return true;
}
/**
* Determine the offset.
* @param tree a <code>JTree</code> object
* @param value a value
* @param isSelected selection status
* @param expanded expansion status
* @param leaf leaf status
* @param row current row
*/
protected void determineOffset(JTree tree, Object value,
boolean isSelected, boolean expanded,
boolean leaf, int row) {
@ -653,6 +662,9 @@ public class DefaultTreeCellEditor implements ActionListener, TreeCellEditor,
// This should not be used. It will be removed when new API is
// allowed.
/**
* Do not use.
*/
public void EditorContainer() {
setLayout(null);
}

7
jdk/src/java.desktop/share/classes/javax/swing/tree/DefaultTreeModel.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -657,9 +657,8 @@ public class DefaultTreeModel implements Serializable, TreeModel {
*
* If no such listeners exist, this method returns an empty array.
*
* @param listenerType the type of listeners requested; this parameter
* should specify an interface that descends from
* <code>java.util.EventListener</code>
* @param <T> the listener type
* @param listenerType the type of listeners requested
* @return an array of all objects registered as
* <code><em>Foo</em>Listener</code>s on this component,
* or an empty array if no such

7
jdk/src/java.desktop/share/classes/javax/swing/tree/DefaultTreeSelectionModel.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -664,9 +664,8 @@ public class DefaultTreeSelectionModel implements Cloneable, Serializable, TreeS
*
* If no such listeners exist, this method returns an empty array.
*
* @param listenerType the type of listeners requested; this parameter
* should specify an interface that descends from
* <code>java.util.EventListener</code>
* @param <T> the listener type
* @param listenerType the type of listeners requested
* @return an array of all objects registered as
* <code><em>Foo</em>Listener</code>s on this component,
* or an empty array if no such

6
jdk/src/java.desktop/share/classes/javax/swing/tree/FixedHeightLayoutCache.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1998, 2014, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1998, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -74,7 +74,9 @@ public class FixedHeightLayoutCache extends AbstractLayoutCache {
private Stack<Stack<TreePath>> tempStacks;
/**
* Constructs a {@code FixedHeightLayoutCache}.
*/
public FixedHeightLayoutCache() {
super();
tempStacks = new Stack<Stack<TreePath>>();

5
jdk/src/java.desktop/share/classes/javax/swing/tree/VariableHeightLayoutCache.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1998, 2014, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1998, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -88,6 +88,9 @@ public class VariableHeightLayoutCache extends AbstractLayoutCache {
private Stack<Stack<TreePath>> tempStacks;
/**
* Constructs a {@code VariableHeightLayoutCache}.
*/
public VariableHeightLayoutCache() {
super();
tempStacks = new Stack<Stack<TreePath>>();

5
jdk/src/java.desktop/share/classes/javax/swing/undo/CompoundEdit.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -45,6 +45,9 @@ public class CompoundEdit extends AbstractUndoableEdit {
*/
protected Vector<UndoableEdit> edits;
/**
* Constructs a {@code CompoundEdit}.
*/
public CompoundEdit() {
super();
inProgress = true;

10
jdk/src/java.desktop/share/classes/javax/swing/undo/StateEdit.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -59,6 +59,9 @@ import java.util.Vector;
public class StateEdit
extends AbstractUndoableEdit {
/**
* Obsolete RCS version identity.
*/
protected static final String RCSID = "$Id: StateEdit.java,v 1.6 1997/10/01 20:05:51 sandipc Exp $";
//
@ -114,6 +117,11 @@ public class StateEdit
init (anObject,name);
}
/**
* Initialize the state edit.
* @param anObject The object to watch for changing state
* @param name The presentation name to be used for this edit
*/
protected void init (StateEditable anObject, String name) {
this.object = anObject;
this.preState = new Hashtable<Object, Object>(11);

14
jdk/src/java.desktop/share/classes/javax/swing/undo/UndoableEditSupport.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2008, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -34,9 +34,21 @@ import java.util.*;
* @author Ray Ryan
*/
public class UndoableEditSupport {
/**
* The update level.
*/
protected int updateLevel;
/**
* The compound edit.
*/
protected CompoundEdit compoundEdit;
/**
* The list of listeners.
*/
protected Vector<UndoableEditListener> listeners;
/**
* The real source.
*/
protected Object realSource;
/**