< prev index next >

src/java.desktop/share/classes/javax/swing/text/View.java

Print this page

        

@@ -379,10 +379,11 @@
     }
 
     /**
      * Removes one of the children at the given position.
      * This is a convenience call to <code>replace</code>.
+     * @param i the position
      * @since 1.3
      */
     public void remove(int i) {
         replace(i, 1, null);
     }

@@ -442,10 +443,11 @@
      * the model.  By default a view has no children so this is implemented
      * to return -1 to indicate there is no valid child index for any
      * position.
      *
      * @param pos the position &gt;= 0
+     * @param b the bias
      * @return  index of the view representing the given position, or
      *   -1 if no view represents that position
      * @since 1.3
      */
     public int getViewIndex(int pos, Position.Bias b) {

@@ -478,20 +480,22 @@
      * within the range of &gt;=0.  If the value is -1, a position
      * will be calculated automatically.  If the value &lt; -1,
      * the {@code BadLocationException} will be thrown.
      *
      * @param pos the position to convert
+     * @param b the bias
      * @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.
      *  This will be one of the following values:
      * <ul>
      * <li>SwingConstants.WEST
      * <li>SwingConstants.EAST
      * <li>SwingConstants.NORTH
      * <li>SwingConstants.SOUTH
      * </ul>
+     * @param biasRet the returned bias
      * @return the location within the model that best represents the next
      *  location visual position
      * @exception BadLocationException the given position is not a valid
      *                                 position within the document
      * @exception IllegalArgumentException if <code>direction</code>

@@ -660,10 +664,11 @@
      * character in the model.
      *
      * @param x the X coordinate &gt;= 0
      * @param y the Y coordinate &gt;= 0
      * @param a the allocated region in which to render
+     * @param biasReturn the returned bias
      * @return the location within the model that best represents the
      *  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.

@@ -862,10 +867,11 @@
      * subclasses.
      * Each view should document what attributes it recognizes
      * for the purpose of rendering or layout, and should always
      * access them through the <code>AttributeSet</code> returned
      * by this method.
+     * @return the attributes to use when rendering
      */
     public AttributeSet getAttributes() {
         return elem.getAttributes();
     }
 

@@ -1024,10 +1030,14 @@
 
     /**
      * Returns the tooltip text at the specified location. The default
      * implementation returns the value from the child View identified by
      * the passed in location.
+     * @param x the x coordinate
+     * @param y the y coordinate
+     * @param allocation current allocation of the View.
+     * @return the tooltip text at the specified location
      *
      * @since 1.4
      * @see JTextComponent#getToolTipText
      */
     public String getToolTipText(float x, float y, Shape allocation) {
< prev index next >