< prev index next >

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

Print this page

        

@@ -50,11 +50,11 @@
  * classes and carry only a small amount of state of their own)
  * so they can share its resources.
  * <p>
  * Since this view
  * represents text that may have tabs embedded in it, it implements the
- * <code>TabableView</code> interface.  Tabs will only be
+ * {@code TabableView} interface.  Tabs will only be
  * expanded if this view is embedded in a container that does
  * tab expansion.  ParagraphView is an example of a container
  * that does tab expansion.
  *
  * @since 1.3

@@ -122,11 +122,11 @@
      * the GlyphPainter to determine what characters
      * it should render glyphs for.
      *
      * @param p0  the starting document offset &gt;= 0
      * @param p1  the ending document offset &gt;= p0
-     * @return    the <code>Segment</code> containing the text
+     * @return    the {@code Segment} containing the text
      */
      public Segment getText(int p0, int p1) {
          // When done with the returned Segment it should be released by
          // invoking:
          //    SegmentCache.releaseSharedSegment(segment);

@@ -142,11 +142,11 @@
 
     /**
      * Fetch the background color to use to render the
      * glyphs.  If there is no background color, null should
      * be returned.  This is implemented to call
-     * <code>StyledDocument.getBackground</code> if the associated
+     * {@code StyledDocument.getBackground} if the associated
      * document is a styled document, otherwise it returns null.
      * @return the background color to use to render the glyphs
      */
     public Color getBackground() {
         Document doc = getDocument();

@@ -161,11 +161,11 @@
 
     /**
      * Fetch the foreground color to use to render the
      * glyphs.  If there is no foreground color, null should
      * be returned.  This is implemented to call
-     * <code>StyledDocument.getBackground</code> if the associated
+     * {@code StyledDocument.getBackground} if the associated
      * document is a StyledDocument.  If the associated document
      * is not a StyledDocument, the associated components foreground
      * color is used.  If there is no associated component, null
      * is returned.
      * @return the foreground color to use to render the glyphs

@@ -184,11 +184,11 @@
     }
 
     /**
      * Fetch the font that the glyphs should be based
      * upon.  This is implemented to call
-     * <code>StyledDocument.getFont</code> if the associated
+     * {@code StyledDocument.getFont} if the associated
      * document is a StyledDocument.  If the associated document
      * is not a StyledDocument, the associated components font
      * is used.  If there is no associated component, null
      * is returned.
      * @return the font that the glyphs should be based upon

@@ -648,12 +648,12 @@
      * 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 &gt;= 0
      * @param a   the allocated region to render into
-     * @param b   either <code>Position.Bias.Forward</code>
-     *                or <code>Position.Bias.Backward</code>
+     * @param b   either {@code Position.Bias.Forward}
+     *                or {@code Position.Bias.Backward}
      * @return the bounding box of the given position
      * @exception BadLocationException  if the given position does not represent a
      *   valid location in the associated document
      * @see View#modelToView
      */

@@ -667,12 +667,12 @@
      * coordinate space of the model.
      *
      * @param x the X coordinate &gt;= 0
      * @param y the Y coordinate &gt;= 0
      * @param a the allocated region to render into
-     * @param biasReturn either <code>Position.Bias.Forward</code>
-     *  or <code>Position.Bias.Backward</code> is returned as the
+     * @param biasReturn either {@code Position.Bias.Forward}
+     *  or {@code Position.Bias.Backward} is returned as the
      *  zero-th element of this array
      * @return the location within the model that best represents the
      *  given point of view &gt;= 0
      * @see View#viewToModel
      */

@@ -682,16 +682,16 @@
     }
 
     /**
      * Determines how attractive a break opportunity in
      * this view is.  This can be used for determining which
-     * view is the most attractive to call <code>breakView</code>
+     * view is the most attractive to call {@code breakView}
      * on in the process of formatting.  The
      * higher the weight, the more attractive the break.  A
-     * value equal to or lower than <code>View.BadBreakWeight</code>
+     * value equal to or lower than {@code View.BadBreakWeight}
      * should not be considered for a break.  A value greater
-     * than or equal to <code>View.ForcedBreakWeight</code> should
+     * than or equal to {@code View.ForcedBreakWeight} should
      * be broken.
      * <p>
      * This is implemented to forward to the superclass for
      * the Y_AXIS.  Along the X_AXIS the following values
      * may be returned.

@@ -1201,15 +1201,15 @@
         /**
          * Provides a mapping from the document model coordinate space
          * to the coordinate space of the view mapped to it.
          * This is shared by the broken views.
          *
-         * @param v     the <code>GlyphView</code> containing the
+         * @param v     the {@code GlyphView} containing the
          *              destination coordinate space
          * @param pos   the position to convert
-         * @param bias  either <code>Position.Bias.Forward</code>
-         *                  or <code>Position.Bias.Backward</code>
+         * @param bias  either {@code Position.Bias.Forward}
+         *                  or {@code Position.Bias.Backward}
          * @param a     Bounds of the View
          * @return      the bounding box of the given position
          * @exception BadLocationException  if the given position does not represent a
          *   valid location in the associated document
          * @see View#modelToView

@@ -1220,16 +1220,16 @@
 
         /**
          * Provides a mapping from the view coordinate space to the logical
          * coordinate space of the model.
          *
-         * @param v          the <code>GlyphView</code> to provide a mapping for
+         * @param v          the {@code GlyphView} to provide a mapping for
          * @param x          the X coordinate
          * @param y          the Y coordinate
          * @param a          the allocated region to render into
-         * @param biasReturn either <code>Position.Bias.Forward</code>
-         *                   or <code>Position.Bias.Backward</code>
+         * @param biasReturn either {@code Position.Bias.Forward}
+         *                   or {@code Position.Bias.Backward}
          *                   is returned as the zero-th element of this array
          * @return the location within the model that best represents the
          *         given point of view
          * @see View#viewToModel
          */

@@ -1262,11 +1262,11 @@
          * Create a painter to use for the given GlyphView.  If
          * the painter carries state it can create another painter
          * to represent a new GlyphView that is being created.  If
          * the painter doesn't hold any significant state, it can
          * return itself.  The default behavior is to return itself.
-         * @param v  the <code>GlyphView</code> to provide a painter for
+         * @param v  the {@code GlyphView} to provide a painter for
          * @param p0 the starting document offset &gt;= 0
          * @param p1 the ending document offset &gt;= p0
          * @return a painter to use for the given GlyphView
          */
         public GlyphPainter getPainter(GlyphView v, int p0, int p1) {

@@ -1280,19 +1280,19 @@
          * they just might not allow access to some of the locations in the
          * model.
          *
          * @param v the view to use
          * @param pos the position to convert &gt;= 0
-         * @param b   either <code>Position.Bias.Forward</code>
-         *                or <code>Position.Bias.Backward</code>
+         * @param b   either {@code Position.Bias.Forward}
+         *                or {@code Position.Bias.Backward}
          * @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 SwingConstants.WEST, SwingConstants.EAST,
          *  SwingConstants.NORTH, or SwingConstants.SOUTH.
-         * @param biasRet  either <code>Position.Bias.Forward</code>
-         *                 or <code>Position.Bias.Backward</code>
+         * @param biasRet  either {@code Position.Bias.Forward}
+         *                 or {@code Position.Bias.Backward}
          *                 is returned as the zero-th element of this array
          * @return the location within the model that best represents the next
          *  location visual position.
          * @exception BadLocationException for a bad location within a document model
          * @exception IllegalArgumentException for an invalid direction
< prev index next >