Build 1.0_r1(from source)

android.text
Class StaticLayout

java.lang.Object
  extended by android.text.Layout
      extended by android.text.StaticLayout

public class StaticLayout
extends Layout

StaticLayout is a Layout for text that will not be edited after it is laid out. Use DynamicLayout for text that may change.

This is used by widgets to control text layout. You should not need to use this class directly unless you are implementing your own widget or custom display object, or would be tempted to call Canvas.drawText() directly.


Nested Class Summary
 
Nested classes/interfaces inherited from class android.text.Layout
Layout.Alignment, Layout.Directions, Layout.Ellipsizer, Layout.SpannedEllipsizer
 
Field Summary
 
Fields inherited from class android.text.Layout
DIR_LEFT_TO_RIGHT, DIR_RIGHT_TO_LEFT, DIRS_ALL_LEFT_TO_RIGHT, DIRS_ALL_RIGHT_TO_LEFT, mWorkPaint
 
Constructor Summary
StaticLayout(boolean ellipsize)
           
StaticLayout(CharSequence source, int bufstart, int bufend, TextPaint paint, int outerwidth, Layout.Alignment align, float spacingmult, float spacingadd, boolean includepad)
           
StaticLayout(CharSequence source, int bufstart, int bufend, TextPaint paint, int outerwidth, Layout.Alignment align, float spacingmult, float spacingadd, boolean includepad, TextUtils.TruncateAt ellipsize, int ellipsizedWidth)
           
StaticLayout(CharSequence source, TextPaint paint, int width, Layout.Alignment align, float spacingmult, float spacingadd, boolean includepad)
           
 
Method Summary
(package private)  void generate(CharSequence source, int bufstart, int bufend, TextPaint paint, int outerwidth, Layout.Alignment align, float spacingmult, float spacingadd, boolean includepad, boolean trackpad, boolean breakOnlyAtSpaces, float ellipsizedWidth, TextUtils.TruncateAt where)
           
 int getBottomPadding()
          Returns the number of extra pixels of descent padding in the bottom line of the Layout.
 int getEllipsisCount(int line)
          Returns the number of characters to be ellipsized away, or 0 if no ellipsis is to take place.
 int getEllipsisStart(int line)
          Return the offset of the first character to be ellipsized away, relative to the start of the line.
 int getEllipsizedWidth()
          Return the width to which this Layout is ellipsizing, or Layout.getWidth() if it is not doing anything special.
 boolean getLineContainsTab(int line)
          Returns whether the specified line contains one or more tabs.
 int getLineCount()
          Return the number of lines of text in this layout.
 int getLineDescent(int line)
          Return the descent of the specified line.
 Layout.Directions getLineDirections(int line)
          Returns an array of directionalities for the specified line.
 int getLineForVertical(int vertical)
          Get the line number corresponding to the specified vertical position.
 int getLineStart(int line)
          Return the text offset of the beginning of the specified line.
 int getLineTop(int line)
          Return the vertical position of the top of the specified line.
 int getParagraphDirection(int line)
          Returns the primary directionality of the paragraph containing the specified line.
 int getTopPadding()
          Returns the (negative) number of extra pixels of ascent padding in the top line of the Layout.
 
Methods inherited from class android.text.Layout
draw, draw, getAlignment, getCursorPath, getDesiredWidth, getDesiredWidth, getHeight, getLineAscent, getLineBaseline, getLineBottom, getLineBounds, getLineEnd, getLineForOffset, getLineLeft, getLineMax, getLineRight, getLineVisibleEnd, getLineWidth, getOffsetForHorizontal, getOffsetToLeftOf, getOffsetToRightOf, getPaint, getParagraphAlignment, getParagraphLeft, getParagraphRight, getPrimaryHorizontal, getSecondaryHorizontal, getSelectionPath, getSpacingAdd, getSpacingMultiplier, getText, getWidth, increaseWidthTo, isSpanned, measureText, nextTab, replaceWith
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StaticLayout

public StaticLayout(CharSequence source,
                    TextPaint paint,
                    int width,
                    Layout.Alignment align,
                    float spacingmult,
                    float spacingadd,
                    boolean includepad)

StaticLayout

public StaticLayout(CharSequence source,
                    int bufstart,
                    int bufend,
                    TextPaint paint,
                    int outerwidth,
                    Layout.Alignment align,
                    float spacingmult,
                    float spacingadd,
                    boolean includepad)

StaticLayout

public StaticLayout(CharSequence source,
                    int bufstart,
                    int bufend,
                    TextPaint paint,
                    int outerwidth,
                    Layout.Alignment align,
                    float spacingmult,
                    float spacingadd,
                    boolean includepad,
                    TextUtils.TruncateAt ellipsize,
                    int ellipsizedWidth)

StaticLayout

StaticLayout(boolean ellipsize)
Method Detail

generate

void generate(CharSequence source,
              int bufstart,
              int bufend,
              TextPaint paint,
              int outerwidth,
              Layout.Alignment align,
              float spacingmult,
              float spacingadd,
              boolean includepad,
              boolean trackpad,
              boolean breakOnlyAtSpaces,
              float ellipsizedWidth,
              TextUtils.TruncateAt where)

getLineForVertical

public int getLineForVertical(int vertical)
Description copied from class: Layout
Get the line number corresponding to the specified vertical position. If you ask for a position above 0, you get 0; if you ask for a position below the bottom of the text, you get the last line.

Overrides:
getLineForVertical in class Layout

getLineCount

public int getLineCount()
Description copied from class: Layout
Return the number of lines of text in this layout.

Specified by:
getLineCount in class Layout

getLineTop

public int getLineTop(int line)
Description copied from class: Layout
Return the vertical position of the top of the specified line. If the specified line is one beyond the last line, returns the bottom of the last line.

Specified by:
getLineTop in class Layout

getLineDescent

public int getLineDescent(int line)
Description copied from class: Layout
Return the descent of the specified line.

Specified by:
getLineDescent in class Layout

getLineStart

public int getLineStart(int line)
Description copied from class: Layout
Return the text offset of the beginning of the specified line. If the specified line is one beyond the last line, returns the end of the last line.

Specified by:
getLineStart in class Layout

getParagraphDirection

public int getParagraphDirection(int line)
Description copied from class: Layout
Returns the primary directionality of the paragraph containing the specified line.

Specified by:
getParagraphDirection in class Layout

getLineContainsTab

public boolean getLineContainsTab(int line)
Description copied from class: Layout
Returns whether the specified line contains one or more tabs.

Specified by:
getLineContainsTab in class Layout

getLineDirections

public final Layout.Directions getLineDirections(int line)
Description copied from class: Layout
Returns an array of directionalities for the specified line. The array alternates counts of characters in left-to-right and right-to-left segments of the line.

Specified by:
getLineDirections in class Layout

getTopPadding

public int getTopPadding()
Description copied from class: Layout
Returns the (negative) number of extra pixels of ascent padding in the top line of the Layout.

Specified by:
getTopPadding in class Layout

getBottomPadding

public int getBottomPadding()
Description copied from class: Layout
Returns the number of extra pixels of descent padding in the bottom line of the Layout.

Specified by:
getBottomPadding in class Layout

getEllipsisCount

public int getEllipsisCount(int line)
Description copied from class: Layout
Returns the number of characters to be ellipsized away, or 0 if no ellipsis is to take place.

Specified by:
getEllipsisCount in class Layout

getEllipsisStart

public int getEllipsisStart(int line)
Description copied from class: Layout
Return the offset of the first character to be ellipsized away, relative to the start of the line. (So 0 if the beginning of the line is ellipsized, not getLineStart().)

Specified by:
getEllipsisStart in class Layout

getEllipsizedWidth

public int getEllipsizedWidth()
Description copied from class: Layout
Return the width to which this Layout is ellipsizing, or Layout.getWidth() if it is not doing anything special.

Overrides:
getEllipsizedWidth in class Layout

Build 1.0_r1(from source)

Please submit a feedback, bug or feature