infernap12/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2026-05-23 20:07:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

8025249: [javadoc] fix some javadoc errors in javax/swing/

Browse Source 
Reviewed-by: alexsch, yan
This commit is contained in:
Taras Ledkov 2013-09-27 12:35:43 +04:00 committed by Yuri Nesterenko
parent e866ac23f9
commit 7569765f7e
19 changed files with 162 additions and 163 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
jdk/src/share/classes/javax/swing/border/CompoundBorder.java
View File

@ -37,11 +37,11 @@ import java.beans.ConstructorProperties;
* For example, this class may be used to add blank margin space
* to a component with an existing decorative border:
* <p>
* <code><pre>
* <pre>
* Border border = comp.getBorder();
* Border margin = new EmptyBorder(10,10,10,10);
* comp.setBorder(new CompoundBorder(border, margin));
* </pre></code>
* </pre>
* <p>
* <strong>Warning:</strong>
* Serialized objects of this class will not be compatible with

6
jdk/src/share/classes/javax/swing/colorchooser/AbstractColorChooserPanel.java
View File

@ -85,7 +85,7 @@ public abstract class AbstractColorChooserPanel extends JPanel {
/**
* Provides a hint to the look and feel as to the
* <code>KeyEvent.VK</code> constant that can be used as a mnemonic to
* access the panel. A return value <= 0 indicates there is no mnemonic.
* access the panel. A return value &lt;= 0 indicates there is no mnemonic.
* <p>
* The return value here is a hint, it is ultimately up to the look
* and feel to honor the return value in some meaningful way.
@ -94,7 +94,7 @@ public abstract class AbstractColorChooserPanel extends JPanel {
* <code>AbstractColorChooserPanel</code> does not support a mnemonic,
* subclasses wishing a mnemonic will need to override this.
*
* @return KeyEvent.VK constant identifying the mnemonic; <= 0 for no
* @return KeyEvent.VK constant identifying the mnemonic; &lt;= 0 for no
* mnemonic
* @see #getDisplayedMnemonicIndex
* @since 1.4
@ -107,7 +107,7 @@ public abstract class AbstractColorChooserPanel extends JPanel {
* Provides a hint to the look and feel as to the index of the character in
* <code>getDisplayName</code> that should be visually identified as the
* mnemonic. The look and feel should only use this if
* <code>getMnemonic</code> returns a value > 0.
* <code>getMnemonic</code> returns a value &gt; 0.
* <p>
* The return value here is a hint, it is ultimately up to the look
* and feel to honor the return value in some meaningful way. For example,

4
jdk/src/share/classes/javax/swing/event/CaretEvent.java
View File

@ -56,7 +56,7 @@ public abstract class CaretEvent extends EventObject {
/**
* Fetches the location of the caret.
*
* @return the dot >= 0
* @return the dot &gt;= 0
*/
public abstract int getDot();
@ -65,7 +65,7 @@ public abstract class CaretEvent extends EventObject {
* selection. If there is no selection, this
* will be the same as dot.
*
* @return the mark >= 0
* @return the mark &gt;= 0
*/
public abstract int getMark();
}

6
jdk/src/share/classes/javax/swing/event/DocumentEvent.java
View File

@ -45,14 +45,14 @@ public interface DocumentEvent {
* Returns the offset within the document of the start
* of the change.
*
* @return the offset >= 0
* @return the offset &gt;= 0
*/
public int getOffset();
/**
* Returns the length of the change.
*
* @return the length >= 0
* @return the length &gt;= 0
*/
public int getLength();
@ -155,7 +155,7 @@ public interface DocumentEvent {
* This is the location that children were added
* and/or removed.
*
* @return the index >= 0
* @return the index &gt;= 0
*/
public int getIndex();

2
jdk/src/share/classes/javax/swing/event/EventListenerList.java
View File

@ -69,7 +69,7 @@ import java.lang.reflect.Array;
* Object[] listeners = listenerList.getListenerList();
* // Process the listeners last to first, notifying
* // those that are interested in this event
* for (int i = listeners.length-2; i>=0; i-=2) {
* for (int i = listeners.length-2; i&gt;=0; i-=2) {
* if (listeners[i]==FooListener.class) {
* // Lazily create the event:
* if (fooEvent == null)

4
jdk/src/share/classes/javax/swing/event/ListDataEvent.java
View File

@ -85,9 +85,9 @@ public class ListDataEvent extends EventObject
public int getIndex1() { return index1; }
/**
* Constructs a ListDataEvent object. If index0 is >
* Constructs a ListDataEvent object. If index0 is &gt;
* index1, index0 and index1 will be swapped such that
* index0 will always be <= index1.
* index0 will always be &lt;= index1.
*
* @param source the source Object (typically <code>this</code>)
* @param type an int specifying {@link #CONTENTS_CHANGED},

8
jdk/src/share/classes/javax/swing/event/TreeModelEvent.java
View File

@ -101,14 +101,14 @@ public class TreeModelEvent extends EventObject {
* of initial-positions, you then need to convert the Vector of <code>Integer</code>
* objects to an array of <code>int</code> to create the event.
* <p>
* <b>Notes:</b><ul>
* <b>Notes:</b><ul style="list-style-type:none">
* <li>Like the <code>insertNodeInto</code> method in the
* <code>DefaultTreeModel</code> class, <code>insertElementAt</code>
* appends to the <code>Vector</code> when the index matches the size
* of the vector. So you can use <code>insertElementAt(Integer, 0)</code>
* even when the vector is empty.
* <ul>To create a node changed event for the root node, specify the parent
* and the child indices as <code>null</code>.
* even when the vector is empty.</li>
* <li>To create a node changed event for the root node, specify the parent
* and the child indices as <code>null</code>.</li>
* </ul>
*
* @param source the Object responsible for generating the event (typically

6
jdk/src/share/classes/javax/swing/filechooser/FileView.java
View File

@ -31,9 +31,9 @@ import javax.swing.*;
/**
* <code>FileView</code> defines an abstract class that can be implemented
* to provide the filechooser with UI information for a <code>File</code>.
* Each L&F <code>JFileChooserUI</code> object implements this
* Each L&amp;F <code>JFileChooserUI</code> object implements this
* class to pass back the correct icons and type descriptions specific to
* that L&F. For example, the Microsoft Windows L&F returns the
* that L&amp;F. For example, the Microsoft Windows L&amp;F returns the
* generic Windows icons for directories and generic files.
* Additionally, you may want to provide your own <code>FileView</code> to
* <code>JFileChooser</code> to return different icons or additional
@ -44,7 +44,7 @@ import javax.swing.*;
* <code>JFileChooser</code> first looks to see if there is a user defined
* <code>FileView</code>, if there is, it gets type information from
* there first. If <code>FileView</code> returns <code>null</code> for
* any method, <code>JFileChooser</code> then uses the L&F specific
* any method, <code>JFileChooser</code> then uses the L&amp;F specific
* view to get the information.
* So, for example, if you provide a <code>FileView</code> class that
* returns an <code>Icon</code> for JPG files, and returns <code>null</code>

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

@ -150,7 +150,7 @@ public class DefaultTableCellRenderer extends JLabel
/**
* Notification from the <code>UIManager</code> that the look and feel
* [L&F] has changed.
* [L&amp;F] has changed.
* Replaces the current UI object with the latest version from the
* <code>UIManager</code>.
*

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

@ -418,15 +418,14 @@ public class DefaultTableModel extends AbstractTableModel implements Serializabl
*
* <pre>
* Examples of moves:
* <p>
*
* 1. moveRow(1,3,5);
* a|B|C|D|e|f|g|h|i|j|k - before
* a|e|f|g|h|B|C|D|i|j|k - after
* <p>
*
* 2. moveRow(6,7,1);
* a|b|c|d|e|f|G|H|i|j|k - before
* a|G|H|b|c|d|e|f|i|j|k - after
* <p>
* </pre>
*
* @param start the starting row index to be moved

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

@ -437,7 +437,7 @@ public class JTableHeader extends JComponent implements TableColumnModelListener
//
/**
* Returns the look and feel (L&F) object that renders this component.
* Returns the look and feel (L&amp;F) object that renders this component.
*
* @return the <code>TableHeaderUI</code> object that renders this component
*/
@ -446,9 +446,9 @@ public class JTableHeader extends JComponent implements TableColumnModelListener
}
/**
* Sets the look and feel (L&F) object that renders this component.
* Sets the look and feel (L&amp;F) object that renders this component.
*
* @param ui the <code>TableHeaderUI</code> L&F object
* @param ui the <code>TableHeaderUI</code> L&amp;F object
* @see UIDefaults#getUI
*/
public void setUI(TableHeaderUI ui){
@ -460,7 +460,7 @@ public class JTableHeader extends JComponent implements TableColumnModelListener
/**
* Notification from the <code>UIManager</code> that the look and feel
* (L&F) has changed.
* (L&amp;F) has changed.
* Replaces the current UI object with the latest version from the
* <code>UIManager</code>.
*
@ -478,7 +478,7 @@ public class JTableHeader extends JComponent implements TableColumnModelListener
/**
* Returns the suffix used to construct the name of the look and feel
* (L&F) class used to render this component.
* (L&amp;F) class used to render this component.
* @return the string "TableHeaderUI"
*
* @return "TableHeaderUI"

8
jdk/src/share/classes/javax/swing/table/TableCellRenderer.java
View File

@ -49,10 +49,10 @@ public interface TableCellRenderer {
* <pre>
* JTable.DropLocation dropLocation = table.getDropLocation();
* if (dropLocation != null
* && !dropLocation.isInsertRow()
* && !dropLocation.isInsertColumn()
* && dropLocation.getRow() == row
* && dropLocation.getColumn() == column) {
* &amp;&amp; !dropLocation.isInsertRow()
* &amp;&amp; !dropLocation.isInsertColumn()
* &amp;&amp; dropLocation.getRow() == row
* &amp;&amp; dropLocation.getColumn() == column) {
*
* // this cell represents the current drop location
* // so render it specially, perhaps with a different color

106
jdk/src/share/classes/javax/swing/text/AbstractDocument.java
View File

@ -426,7 +426,7 @@ public abstract class AbstractDocument implements Document, Serializable {
* Returns the length of the data. This is the number of
* characters of content that represents the users data.
*
* @return the length >= 0
* @return the length &gt;= 0
* @see Document#getLength
*/
public int getLength() {
@ -572,8 +572,8 @@ public abstract class AbstractDocument implements Document, Serializable {
* <A HREF="http://download.oracle.com/javase/tutorial/uiswing/concurrency/index.html">Concurrency
* in Swing</A> for more information.
*
* @param offs the starting offset >= 0
* @param len the number of characters to remove >= 0
* @param offs the starting offset &gt;= 0
* @param len the number of characters to remove &gt;= 0
* @exception BadLocationException the given remove position is not a valid
* position within the document
* @see Document#remove
@ -685,7 +685,7 @@ public abstract class AbstractDocument implements Document, Serializable {
* <A HREF="http://download.oracle.com/javase/tutorial/uiswing/concurrency/index.html">Concurrency
* in Swing</A> for more information.
*
* @param offs the starting offset >= 0
* @param offs the starting offset &gt;= 0
* @param str the string to insert; does nothing with null/empty strings
* @param a the attributes for the inserted content
* @exception BadLocationException the given insert position is not a valid
@ -777,8 +777,8 @@ public abstract class AbstractDocument implements Document, Serializable {
/**
* Gets a sequence of text from the document.
*
* @param offset the starting offset >= 0
* @param length the number of characters to retrieve >= 0
* @param offset the starting offset &gt;= 0
* @param length the number of characters to retrieve &gt;= 0
* @return the text
* @exception BadLocationException the range given includes a position
* that is not a valid position within the document
@ -810,7 +810,7 @@ public abstract class AbstractDocument implements Document, Serializable {
* &nbsp; Segment text = new Segment();
* &nbsp; int offs = 0;
* &nbsp; text.setPartialReturn(true);
* &nbsp; while (nleft > 0) {
* &nbsp; while (nleft &gt; 0) {
* &nbsp; doc.getText(offs, nleft, text);
* &nbsp; // do something with text
* &nbsp; nleft -= text.count;
@ -818,8 +818,8 @@ public abstract class AbstractDocument implements Document, Serializable {
* &nbsp; }
* </pre>
*
* @param offset the starting offset >= 0
* @param length the number of characters to retrieve >= 0
* @param offset the starting offset &gt;= 0
* @param length the number of characters to retrieve &gt;= 0
* @param txt the Segment object to retrieve the text into
* @exception BadLocationException the range given includes a position
* that is not a valid position within the document
@ -840,7 +840,7 @@ public abstract class AbstractDocument implements Document, Serializable {
* <A HREF="http://download.oracle.com/javase/tutorial/uiswing/concurrency/index.html">Concurrency
* in Swing</A> for more information.
*
* @param offs the position in the model >= 0
* @param offs the position in the model &gt;= 0
* @return the position
* @exception BadLocationException if the given position does not
* represent a valid location in the associated document
@ -956,7 +956,7 @@ public abstract class AbstractDocument implements Document, Serializable {
* should keep in mind however that a paragraph should at least be the
* unit of text over which to run the Unicode bidirectional algorithm.
*
* @param pos the starting offset >= 0
* @param pos the starting offset &gt;= 0
* @return the element */
public abstract Element getParagraphElement(int pos);
@ -1288,8 +1288,8 @@ public abstract class AbstractDocument implements Document, Serializable {
*
* @param parent the parent element
* @param a the attributes for the element
* @param p0 the beginning of the range >= 0
* @param p1 the end of the range >= p0
* @param p0 the beginning of the range &gt;= 0
* @param p1 the end of the range &gt;= p0
* @return the new element
*/
protected Element createLeafElement(Element parent, AttributeSet a, int p0, int p1) {
@ -1610,7 +1610,7 @@ public abstract class AbstractDocument implements Document, Serializable {
* Creates a position within the content that will
* track change as the content is mutated.
*
* @param offset the offset in the content >= 0
* @param offset the offset in the content &gt;= 0
* @return a Position
* @exception BadLocationException for an invalid offset
*/
@ -1619,14 +1619,14 @@ public abstract class AbstractDocument implements Document, Serializable {
/**
* Current length of the sequence of character content.
*
* @return the length >= 0
* @return the length &gt;= 0
*/
public int length();
/**
* Inserts a string of characters into the sequence.
*
* @param where offset into the sequence to make the insertion >= 0
* @param where offset into the sequence to make the insertion &gt;= 0
* @param str string to insert
* @return if the implementation supports a history mechanism,
* a reference to an <code>Edit</code> implementation will be returned,
@ -1640,8 +1640,8 @@ public abstract class AbstractDocument implements Document, Serializable {
* Removes some portion of the sequence.
*
* @param where The offset into the sequence to make the
* insertion >= 0.
* @param nitems The number of items in the sequence to remove >= 0.
* insertion &gt;= 0.
* @param nitems The number of items in the sequence to remove &gt;= 0.
* @return If the implementation supports a history mechansim,
* a reference to an Edit implementation will be returned,
* otherwise null.
@ -1653,8 +1653,8 @@ public abstract class AbstractDocument implements Document, Serializable {
/**
* Fetches a string of characters contained in the sequence.
*
* @param where Offset into the sequence to fetch >= 0.
* @param len number of characters to copy >= 0.
* @param where Offset into the sequence to fetch &gt;= 0.
* @param len number of characters to copy &gt;= 0.
* @return the string
* @exception BadLocationException Thrown if the area covered by
* the arguments is not contained in the character sequence.
@ -1664,8 +1664,8 @@ public abstract class AbstractDocument implements Document, Serializable {
/**
* Gets a sequence of characters and copies them into a Segment.
*
* @param where the starting offset >= 0
* @param len the number of characters >= 0
* @param where the starting offset &gt;= 0
* @param len the number of characters &gt;= 0
* @param txt the target location to copy into
* @exception BadLocationException Thrown if the area covered by
* the arguments is not contained in the character sequence.
@ -1809,7 +1809,7 @@ public abstract class AbstractDocument implements Document, Serializable {
* Dumps a debugging representation of the element hierarchy.
*
* @param psOut the output stream
* @param indentAmount the indentation level >= 0
* @param indentAmount the indentation level &gt;= 0
*/
public void dump(PrintStream psOut, int indentAmount) {
PrintWriter out;
@ -1867,7 +1867,7 @@ public abstract class AbstractDocument implements Document, Serializable {
/**
* Gets the number of attributes that are defined.
*
* @return the number of attributes >= 0
* @return the number of attributes &gt;= 0
* @see AttributeSet#getAttributeCount
*/
public int getAttributeCount() {
@ -2116,21 +2116,21 @@ public abstract class AbstractDocument implements Document, Serializable {
/**
* Gets the starting offset in the model for the element.
*
* @return the offset >= 0
* @return the offset &gt;= 0
*/
public abstract int getStartOffset();
/**
* Gets the ending offset in the model for the element.
*
* @return the offset >= 0
* @return the offset &gt;= 0
*/
public abstract int getEndOffset();
/**
* Gets a child element.
*
* @param index the child index, >= 0 && < getElementCount()
* @param index the child index, &gt;= 0 &amp;&amp; &lt; getElementCount()
* @return the child element
*/
public abstract Element getElement(int index);
@ -2138,15 +2138,15 @@ public abstract class AbstractDocument implements Document, Serializable {
/**
* Gets the number of children for the element.
*
* @return the number of children >= 0
* @return the number of children &gt;= 0
*/
public abstract int getElementCount();
/**
* Gets the child element index closest to the given model offset.
*
* @param offset the offset >= 0
* @return the element index >= 0
* @param offset the offset &gt;= 0
* @return the element index &gt;= 0
*/
public abstract int getElementIndex(int offset);
@ -2272,7 +2272,7 @@ public abstract class AbstractDocument implements Document, Serializable {
* Gets the child element that contains
* the given model position.
*
* @param pos the position >= 0
* @param pos the position &gt;= 0
* @return the element, null if none
*/
public Element positionToElement(int pos) {
@ -2289,8 +2289,8 @@ public abstract class AbstractDocument implements Document, Serializable {
/**
* Replaces content with a new set of elements.
*
* @param offset the starting offset >= 0
* @param length the length to replace >= 0
* @param offset the starting offset &gt;= 0
* @param length the length to replace &gt;= 0
* @param elems the new elements
*/
public void replace(int offset, int length, Element[] elems) {
@ -2342,7 +2342,7 @@ public abstract class AbstractDocument implements Document, Serializable {
/**
* Gets the starting offset in the model for the element.
*
* @return the offset >= 0
* @return the offset &gt;= 0
*/
public int getStartOffset() {
return children[0].getStartOffset();
@ -2352,7 +2352,7 @@ public abstract class AbstractDocument implements Document, Serializable {
* Gets the ending offset in the model for the element.
* @throws NullPointerException if this element has no children
*
* @return the offset >= 0
* @return the offset &gt;= 0
*/
public int getEndOffset() {
Element child =
@ -2363,7 +2363,7 @@ public abstract class AbstractDocument implements Document, Serializable {
/**
* Gets a child element.
*
* @param index the child index, >= 0 && < getElementCount()
* @param index the child index, &gt;= 0 &amp;&amp; &lt; getElementCount()
* @return the child element, null if none
*/
public Element getElement(int index) {
@ -2376,7 +2376,7 @@ public abstract class AbstractDocument implements Document, Serializable {
/**
* Gets the number of children for the element.
*
* @return the number of children >= 0
* @return the number of children &gt;= 0
*/
public int getElementCount() {
return nchildren;
@ -2385,8 +2385,8 @@ public abstract class AbstractDocument implements Document, Serializable {
/**
* Gets the child element index closest to the given model offset.
*
* @param offset the offset >= 0
* @return the element index >= 0
* @param offset the offset &gt;= 0
* @return the element index &gt;= 0
*/
public int getElementIndex(int offset) {
int index;
@ -2515,8 +2515,8 @@ public abstract class AbstractDocument implements Document, Serializable {
*
* @param parent The parent element
* @param a The element attributes
* @param offs0 The start offset >= 0
* @param offs1 The end offset >= offs0
* @param offs0 The start offset &gt;= 0
* @param offs1 The end offset &gt;= offs0
* @since 1.4
*/
public LeafElement(Element parent, AttributeSet a, int offs0, int offs1) {
@ -2545,7 +2545,7 @@ public abstract class AbstractDocument implements Document, Serializable {
/**
* Gets the starting offset in the model for the element.
*
* @return the offset >= 0
* @return the offset &gt;= 0
*/
public int getStartOffset() {
return p0.getOffset();
@ -2554,7 +2554,7 @@ public abstract class AbstractDocument implements Document, Serializable {
/**
* Gets the ending offset in the model for the element.
*
* @return the offset >= 0
* @return the offset &gt;= 0
*/
public int getEndOffset() {
return p1.getOffset();
@ -2576,8 +2576,8 @@ public abstract class AbstractDocument implements Document, Serializable {
/**
* Gets the child element index closest to the given model offset.
*
* @param pos the offset >= 0
* @return the element index >= 0
* @param pos the offset &gt;= 0
* @return the element index &gt;= 0
*/
public int getElementIndex(int pos) {
return -1;
@ -2586,7 +2586,7 @@ public abstract class AbstractDocument implements Document, Serializable {
/**
* Gets a child element.
*
* @param index the child index, >= 0 && < getElementCount()
* @param index the child index, &gt;= 0 &amp;&amp; &lt; getElementCount()
* @return the child element
*/
public Element getElement(int index) {
@ -2596,7 +2596,7 @@ public abstract class AbstractDocument implements Document, Serializable {
/**
* Returns the number of child elements.
*
* @return the number of children >= 0
* @return the number of children &gt;= 0
*/
public int getElementCount() {
return 0;
@ -2731,8 +2731,8 @@ public abstract class AbstractDocument implements Document, Serializable {
/**
* Constructs a change record.
*
* @param offs the offset into the document of the change >= 0
* @param len the length of the change >= 0
* @param offs the offset into the document of the change &gt;= 0
* @param len the length of the change &gt;= 0
* @param type the type of event (DocumentEvent.EventType)
* @since 1.4
*/
@ -2901,7 +2901,7 @@ public abstract class AbstractDocument implements Document, Serializable {
/**
* Returns the offset within the document of the start of the change.
*
* @return the offset >= 0
* @return the offset &gt;= 0
* @see DocumentEvent#getOffset
*/
public int getOffset() {
@ -2911,7 +2911,7 @@ public abstract class AbstractDocument implements Document, Serializable {
/**
* Returns the length of the change.
*
* @return the length >= 0
* @return the length &gt;= 0
* @see DocumentEvent#getLength
*/
public int getLength() {
@ -3024,7 +3024,7 @@ public abstract class AbstractDocument implements Document, Serializable {
* current model state for views that just attached to a model.
*
* @param e the element
* @param index the index into the model >= 0
* @param index the index into the model &gt;= 0
* @param removed a set of elements that were removed
* @param added a set of elements that were added
*/
@ -3048,7 +3048,7 @@ public abstract class AbstractDocument implements Document, Serializable {
/**
* Returns the index into the list of elements.
*
* @return the index >= 0
* @return the index &gt;= 0
*/
public int getIndex() {
return index;

4
jdk/src/share/classes/javax/swing/text/AbstractWriter.java
View File

@ -417,7 +417,7 @@ public abstract class AbstractWriter {
/**
* Increments the indent level. If indenting would cause
* <code>getIndentSpace()</code> *<code>getIndentLevel()</code> to be >
* <code>getIndentSpace()</code> *<code>getIndentLevel()</code> to be &gt;
* than <code>getLineLength()</code> this will not cause an indent.
*/
protected void incrIndent() {
@ -663,7 +663,7 @@ public abstract class AbstractWriter {
}
/**
* Writes out the set of attributes as " <name>=<value>"
* Writes out the set of attributes as " &lt;name&gt;=&lt;value&gt;"
* pairs. It throws an IOException when encountered.
*
* @param attr an AttributeSet.

50
jdk/src/share/classes/javax/swing/text/AsyncBoxView.java
View File

@ -193,7 +193,7 @@ public class AsyncBoxView extends View {
* of the child at the given index.
*
* @param index the child index. This should be a
* value >= 0 and < getViewCount().
* value &gt;= 0 and &lt; getViewCount().
*/
protected ChildState getChildState(int index) {
synchronized(stats) {
@ -350,8 +350,8 @@ public class AsyncBoxView extends View {
* thread will not happen (i.e. the layout thread
* acquires a read lock before doing anything).
*
* @param offset the starting offset into the child views >= 0
* @param length the number of existing views to replace >= 0
* @param offset the starting offset into the child views &gt;= 0
* @param length the number of existing views to replace &gt;= 0
* @param views the child views to insert
*/
public void replace(int offset, int length, View[] views) {
@ -417,7 +417,7 @@ public class AsyncBoxView extends View {
* the model. This is implemented to fetch the view in the case
* where there is a child view for each child element.
*
* @param pos the position >= 0
* @param pos the position &gt;= 0
* @return index of the view representing the given position, or
* -1 if no view represents that position
*/
@ -525,8 +525,8 @@ public class AsyncBoxView extends View {
* axis. Since the minor axis is flexible, work is queued to resize
* the children if the minor span changes.
*
* @param width the width >= 0
* @param height the height >= 0
* @param width the width &gt;= 0
* @param height the height &gt;= 0
*/
public void setSize(float width, float height) {
setSpanOnAxis(X_AXIS, width);
@ -618,7 +618,7 @@ public class AsyncBoxView extends View {
* axis.
*
* @param axis may be either View.X_AXIS or View.Y_AXIS
* @return the span the view would like to be rendered into >= 0.
* @return the span the view would like to be rendered into &gt;= 0.
* Typically the view is told to render into the span
* that is returned, although there is no guarantee.
* The parent may choose to resize or break the view.
@ -643,7 +643,7 @@ public class AsyncBoxView extends View {
* axis.
*
* @param axis may be either View.X_AXIS or View.Y_AXIS
* @return the span the view would like to be rendered into >= 0.
* @return the span the view would like to be rendered into &gt;= 0.
* Typically the view is told to render into the span
* that is returned, although there is no guarantee.
* The parent may choose to resize or break the view.
@ -671,7 +671,7 @@ public class AsyncBoxView extends View {
* axis.
*
* @param axis may be either View.X_AXIS or View.Y_AXIS
* @return the span the view would like to be rendered into >= 0.
* @return the span the view would like to be rendered into &gt;= 0.
* Typically the view is told to render into the span
* that is returned, although there is no guarantee.
* The parent may choose to resize or break the view.
@ -690,7 +690,7 @@ public class AsyncBoxView extends View {
* the default is to not be a composite view this
* returns 0.
*
* @return the number of views >= 0
* @return the number of views &gt;= 0
* @see View#getViewCount
*/
public int getViewCount() {
@ -703,7 +703,7 @@ public class AsyncBoxView extends View {
* Gets the nth child view. Since there are no
* children by default, this returns null.
*
* @param n the number of the view to get, >= 0 && < getViewCount()
* @param n the number of the view to get, &gt;= 0 &amp;&amp; &lt; getViewCount()
* @return the view
*/
public View getView(int n) {
@ -721,7 +721,7 @@ public class AsyncBoxView extends View {
* their location. This returns null since the
* default is to not have any child views.
*
* @param index the index of the child, >= 0 && < getViewCount()
* @param index the index of the child, &gt;= 0 &amp;&amp; &lt; getViewCount()
* @param a the allocation to this view.
* @return the allocation to the child
*/
@ -736,7 +736,7 @@ public class AsyncBoxView extends View {
* to return -1 to indicate there is no valid child index for any
* position.
*
* @param pos the position >= 0
* @param pos the position &gt;= 0
* @return index of the view representing the given position, or
* -1 if no view represents that position
* @since 1.3
@ -749,7 +749,7 @@ public class AsyncBoxView extends View {
* Provides a mapping from the document model coordinate space
* to the coordinate space of the view mapped to it.
*
* @param pos the position to convert >= 0
* @param pos the position to convert &gt;= 0
* @param a the allocated region to render into
* @param b the bias toward the previous character or the
* next character represented by the offset, in case the
@ -788,11 +788,11 @@ public class AsyncBoxView extends View {
* on the child view with a lock on the ChildState object
* to avoid interaction with the layout thread.
*
* @param x the X coordinate >= 0
* @param y the Y coordinate >= 0
* @param x the X coordinate &gt;= 0
* @param y the Y coordinate &gt;= 0
* @param a the allocated region to render into
* @return the location within the model that best represents the
* given point in the view >= 0. The biasReturn argument will be
* given point in the view &gt;= 0. The biasReturn argument will be
* filled in to indicate that the point given is closer to the next
* character in the model or the previous character in the model.
*/
@ -828,16 +828,16 @@ public class AsyncBoxView extends View {
* they might not be in the same order found in the model, or they just
* might not allow access to some of the locations in the model.
*
* @param pos the position to convert >= 0
* @param pos the position to convert &gt;= 0
* @param a the allocated region to render into
* @param direction the direction from the current position that can
* be thought of as the arrow keys typically found on a keyboard;
* this may be one of the following:
* <ul>
* <code>SwingConstants.WEST</code>
* <code>SwingConstants.EAST</code>
* <code>SwingConstants.NORTH</code>
* <code>SwingConstants.SOUTH</code>
* <ul style="list-style-type:none">
* <li><code>SwingConstants.WEST</code></li>
* <li><code>SwingConstants.EAST</code></li>
* <li><code>SwingConstants.NORTH</code></li>
* <li><code>SwingConstants.SOUTH</code></li>
* </ul>
* @param biasRet an array contain the bias that was checked
* @return the location within the model that best represents the next
@ -1007,8 +1007,8 @@ public class AsyncBoxView extends View {
* with one or more calls to getChildAllocation that
* should also be in the synchronized block.
*
* @param x the X coordinate >= 0
* @param y the Y coordinate >= 0
* @param x the X coordinate &gt;= 0
* @param y the Y coordinate &gt;= 0
* @param a the allocation to the View
* @return the nearest child index
*/

2
jdk/src/share/classes/javax/swing/text/AttributeSet.java
View File

@ -89,7 +89,7 @@ public interface AttributeSet {
* Returns the number of attributes that are defined locally in this set.
* Attributes that are defined in the parent set are not included.
*
* @return the number of attributes >= 0
* @return the number of attributes &gt;= 0
*/
public int getAttributeCount();

22
jdk/src/share/classes/javax/swing/text/Document.java
View File

@ -187,7 +187,7 @@ public interface Document {
* Returns number of characters of content currently
* in the document.
*
* @return number of characters >= 0
* @return number of characters &gt;= 0
*/
public int getLength();
@ -280,8 +280,8 @@ public interface Document {
* If the Document supports undo/redo, an UndoableEditEvent will
* also be generated.
*
* @param offs the offset from the beginning >= 0
* @param len the number of characters to remove >= 0
* @param offs the offset from the beginning &gt;= 0
* @param len the number of characters to remove &gt;= 0
* @exception BadLocationException some portion of the removal range
* was not a valid part of the document. The location in the exception
* is the first bad position encountered.
@ -313,7 +313,7 @@ public interface Document {
* If the Document supports undo/redo, an UndoableEditEvent will
* also be generated.
*
* @param offset the offset into the document to insert the content >= 0.
* @param offset the offset into the document to insert the content &gt;= 0.
* All positions that track change at or after the given location
* will move.
* @param str the string to insert
@ -333,9 +333,9 @@ public interface Document {
* of the document.
*
* @param offset the offset into the document representing the desired
* start of the text >= 0
* @param length the length of the desired string >= 0
* @return the text, in a String of length >= 0
* start of the text &gt;= 0
* @param length the length of the desired string &gt;= 0
* @return the text, in a String of length &gt;= 0
* @exception BadLocationException some portion of the given range
* was not a valid part of the document. The location in the exception
* is the first bad position encountered.
@ -361,7 +361,7 @@ public interface Document {
* &nbsp; Segment text = new Segment();
* &nbsp; int offs = 0;
* &nbsp; text.setPartialReturn(true);
* &nbsp; while (nleft > 0) {
* &nbsp; while (nleft &gt; 0) {
* &nbsp; doc.getText(offs, nleft, text);
* &nbsp; // do someting with text
* &nbsp; nleft -= text.count;
@ -371,8 +371,8 @@ public interface Document {
* </code></pre>
*
* @param offset the offset into the document representing the desired
* start of the text >= 0
* @param length the length of the desired string >= 0
* start of the text &gt;= 0
* @param length the length of the desired string &gt;= 0
* @param txt the Segment object to return the text in
*
* @exception BadLocationException Some portion of the given range
@ -409,7 +409,7 @@ public interface Document {
* insertion is forced to a position that follows the
* original position.
*
* @param offs the offset from the start of the document >= 0
* @param offs the offset from the start of the document &gt;= 0
* @return the position
* @exception BadLocationException if the given position does not
* represent a valid location in the associated document

14
jdk/src/share/classes/javax/swing/text/Element.java
View File

@ -69,7 +69,7 @@ public interface Element {
* children, this will be the offset of the first child.
* As a document position, there is an implied forward bias.
*
* @return the starting offset >= 0 and < getEndOffset();
* @return the starting offset &gt;= 0 and &lt; getEndOffset();
* @see Document
* @see AbstractDocument
*/
@ -87,8 +87,8 @@ public interface Element {
* the document. As a result of this, it is possible for this to
* return a value greater than the length of the document.
*
* @return the ending offset > getStartOffset() and
* <= getDocument().getLength() + 1
* @return the ending offset &gt; getStartOffset() and
* &lt;= getDocument().getLength() + 1
* @see Document
* @see AbstractDocument
*/
@ -105,8 +105,8 @@ public interface Element {
* <code>getElementCount() - 1</code> if the location is
* greater than or equal to the end offset.
*
* @param offset the specified offset >= 0
* @return the element index >= 0
* @param offset the specified offset &gt;= 0
* @return the element index &gt;= 0
*/
public int getElementIndex(int offset);
@ -114,14 +114,14 @@ public interface Element {
* Gets the number of child elements contained by this element.
* If this element is a leaf, a count of zero is returned.
*
* @return the number of child elements >= 0
* @return the number of child elements &gt;= 0
*/
public int getElementCount();
/**
* Fetches the child element at the given index.
*
* @param index the specified index >= 0
* @param index the specified index &gt;= 0
* @return the child element
*/
public Element getElement(int index);

62
jdk/src/share/classes/javax/swing/text/View.java
View File

@ -293,7 +293,7 @@ public abstract class View implements SwingConstants {
/**
* Determines the desired alignment for this view along an
* axis. The desired alignment is returned. This should be
* a value >= 0.0 and <= 1.0, where 0 indicates alignment at
* a value &gt;= 0.0 and &lt;= 1.0, where 0 indicates alignment at
* the origin and 1.0 indicates alignment to the full span
* away from the origin. An alignment of 0.5 would be the
* center of the view.
@ -351,7 +351,7 @@ public abstract class View implements SwingConstants {
* the default is to not be a composite view this
* returns 0.
*
* @return the number of views >= 0
* @return the number of views &gt;= 0
* @see View#getViewCount
*/
public int getViewCount() {
@ -362,7 +362,7 @@ public abstract class View implements SwingConstants {
* Gets the <i>n</i>th child view. Since there are no
* children by default, this returns <code>null</code>.
*
* @param n the number of the view to get, >= 0 && < getViewCount()
* @param n the number of the view to get, &gt;= 0 &amp;&amp; &lt; getViewCount()
* @return the view
*/
public View getView(int n) {
@ -393,7 +393,7 @@ public abstract class View implements SwingConstants {
* Inserts a single child view. This is a convenience
* call to <code>replace</code>.
*
* @param offs the offset of the view to insert before >= 0
* @param offs the offset of the view to insert before &gt;= 0
* @param v the view
* @see #replace
* @since 1.3
@ -428,9 +428,9 @@ public abstract class View implements SwingConstants {
* a view has no children.
*
* @param offset the starting index into the child views to insert
* the new views. This should be a value >= 0 and <= getViewCount
* the new views. This should be a value &gt;= 0 and &lt;= getViewCount
* @param length the number of existing child views to remove
* This should be a value >= 0 and <= (getViewCount() - offset).
* This should be a value &gt;= 0 and &lt;= (getViewCount() - offset).
* @param views the child views to add. This value can be
* <code>null</code> to indicate no children are being added
* (useful to remove).
@ -445,7 +445,7 @@ public abstract class View implements SwingConstants {
* to return -1 to indicate there is no valid child index for any
* position.
*
* @param pos the position >= 0
* @param pos the position &gt;= 0
* @return index of the view representing the given position, or
* -1 if no view represents that position
* @since 1.3
@ -461,7 +461,7 @@ public abstract class View implements SwingConstants {
* their location. This returns <code>null</code> since the
* default is to not have any child views.
*
* @param index the index of the child, >= 0 && <
* @param index the index of the child, &gt;= 0 &amp;&amp; &lt;
* <code>getViewCount()</code>
* @param a the allocation to this view
* @return the allocation to the child
@ -477,7 +477,7 @@ public abstract class View implements SwingConstants {
* they might not be in the same order found in the model, or they just
* might not allow access to some of the locations in the model.
*
* @param pos the position to convert >= 0
* @param pos the position to convert &gt;= 0
* @param a the allocated region in which to render
* @param direction the direction from the current position that can
* be thought of as the arrow keys typically found on a keyboard.
@ -566,7 +566,7 @@ public abstract class View implements SwingConstants {
* from the document model coordinate space
* to the view coordinate space.
*
* @param pos the position of the desired character (>=0)
* @param pos the position of the desired character (&gt;=0)
* @param a the area of the view, which encompasses the requested character
* @param b the bias toward the previous character or the
* next character represented by the offset, in case the
@ -592,17 +592,17 @@ public abstract class View implements SwingConstants {
* to the view coordinate space. The specified region is
* created as a union of the first and last character positions.
*
* @param p0 the position of the first character (>=0)
* @param p0 the position of the first character (&gt;=0)
* @param b0 the bias of the first character position,
* toward the previous character or the
* next character represented by the offset, in case the
* position is a boundary of two views; <code>b0</code> will have one
* of these values:
* <ul>
* <ul style="list-style-type:none">
* <li> <code>Position.Bias.Forward</code>
* <li> <code>Position.Bias.Backward</code>
* </ul>
* @param p1 the position of the last character (>=0)
* @param p1 the position of the last character (&gt;=0)
* @param b1 the bias for the second character position, defined
* one of the legal values shown above
* @param a the area of the view, which encompasses the requested region
@ -656,11 +656,11 @@ public abstract class View implements SwingConstants {
* closer to the next character in the model or the previous
* character in the model.
*
* @param x the X coordinate >= 0
* @param y the Y coordinate >= 0
* @param x the X coordinate &gt;= 0
* @param y the Y coordinate &gt;= 0
* @param a the allocated region in which to render
* @return the location within the model that best represents the
* given point in the view >= 0. The <code>biasReturn</code>
* given point in the view &gt;= 0. The <code>biasReturn</code>
* argument will be
* filled in to indicate that the point given is closer to the next
* character in the model or the previous character in the model.
@ -804,7 +804,7 @@ public abstract class View implements SwingConstants {
* Fetches the portion of the model for which this view is
* responsible.
*
* @return the starting offset into the model >= 0
* @return the starting offset into the model &gt;= 0
* @see View#getStartOffset
*/
public int getStartOffset() {
@ -815,7 +815,7 @@ public abstract class View implements SwingConstants {
* Fetches the portion of the model for which this view is
* responsible.
*
* @return the ending offset into the model >= 0
* @return the ending offset into the model &gt;= 0
* @see View#getEndOffset
*/
public int getEndOffset() {
@ -884,14 +884,14 @@ public abstract class View implements SwingConstants {
* @param axis may be either <code>View.X_AXIS</code> or
* <code>View.Y_AXIS</code>
* @param offset the location in the document model
* that a broken fragment would occupy >= 0. This
* that a broken fragment would occupy &gt;= 0. This
* would be the starting offset of the fragment
* returned
* @param pos the position along the axis that the
* broken view would occupy >= 0. This may be useful for
* broken view would occupy &gt;= 0. This may be useful for
* things like tab calculations
* @param len specifies the distance along the axis
* where a potential break is desired >= 0
* where a potential break is desired &gt;= 0
* @return the fragment of the view that represents the
* given span, if the view can be broken. If the view
* doesn't support breaking behavior, the view itself is
@ -909,10 +909,10 @@ public abstract class View implements SwingConstants {
* the view doesn't support fragmenting (the default), it
* should return itself.
*
* @param p0 the starting offset >= 0. This should be a value
* @param p0 the starting offset &gt;= 0. This should be a value
* greater or equal to the element starting offset and
* less than the element ending offset.
* @param p1 the ending offset > p0. This should be a value
* @param p1 the ending offset &gt; p0. This should be a value
* less than or equal to the elements end offset and
* greater than the elements starting offset.
* @return the view fragment, or itself if the view doesn't
@ -949,10 +949,10 @@ public abstract class View implements SwingConstants {
* @param axis may be either <code>View.X_AXIS</code> or
* <code>View.Y_AXIS</code>
* @param pos the potential location of the start of the
* broken view >= 0. This may be useful for calculating tab
* broken view &gt;= 0. This may be useful for calculating tab
* positions
* @param len specifies the relative length from <em>pos</em>
* where a potential break is desired >= 0
* where a potential break is desired &gt;= 0
* @return the weight, which should be a value between
* ForcedBreakWeight and BadBreakWeight
* @see LabelView
@ -986,8 +986,8 @@ public abstract class View implements SwingConstants {
* layout of the view along the given axis, if it
* has any layout duties.
*
* @param width the width >= 0
* @param height the height >= 0
* @param width the width &gt;= 0
* @param height the height &gt;= 0
*/
public void setSize(float width, float height) {
}
@ -1314,7 +1314,7 @@ public abstract class View implements SwingConstants {
* implemented to default the bias to <code>Position.Bias.Forward</code>
* which was previously implied.
*
* @param pos the position to convert >= 0
* @param pos the position to convert &gt;= 0
* @param a the allocated region in which to render
* @return the bounding box of the given position is returned
* @exception BadLocationException if the given position does
@ -1332,11 +1332,11 @@ public abstract class View implements SwingConstants {
* Provides a mapping from the view coordinate space to the logical
* coordinate space of the model.
*
* @param x the X coordinate >= 0
* @param y the Y coordinate >= 0
* @param x the X coordinate &gt;= 0
* @param y the Y coordinate &gt;= 0
* @param a the allocated region in which to render
* @return the location within the model that best represents the
* given point in the view >= 0
* given point in the view &gt;= 0
* @see View#viewToModel
* @deprecated
*/