TextLines (kfc 1.2.0 API)

java.lang.Object
- jp.kyasu.graphics.TextLines

すべての実装されたインタフェース:

java.io.Serializable

直系の既知のサブクラス:

TextLayout
```
public class TextLines
extends java.lang.Object
implements java.io.Serializable
```
The TextLines class implements an information of the lines into which the rich text is composed. This class is a super class of the TextLayout class. An instance of this class can not be created outside this package.

関連項目:

TextLayout, 直列化された形式

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected int`	`baseline` The baseline of all lines.
`protected VArray`	`baselines` The array for the baseline of the line.
`protected int`	`layoutHeight` The layout height.
`protected VArray`	`lineBegins` The array for the beginning index of the line.
`protected int`	`lineHeight` The height of all lines.
`protected VArray`	`lineTops` The array for the top position of the line.
`protected VArray`	`remainWidths` The array for the remaining width of the line.
`protected RichText`	`richText` The rich text to be composed into lines.
`protected RichTextStyle`	`rtStyle` The style for the rich text.

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`protected void`	`append(TextLineInfo lineInfo)` Appends the line described in the specified text line information to this text lines.
`protected void`	`append(TextLines textLines)` Appends the specified text lines to this text lines.
`protected void`	`assert(boolean b)` Asserts the given boolean to be `true`.
`protected void`	`changeRemainWidths(int diff)` Changes the remaining widths of this text lines with the specified difference of the layout width.
`protected java.awt.Dimension`	`doLayoutForEmpty(int width, int lineWrap)` Lays out the empty text lines with the specified width.
`protected int`	`duplicateLastLine(int width, int lineTop, boolean endWithBreak)` Duplicates the last line, with the specified length of the text, layout width, the paragraph style of the last line, and flag indicating that the last line is ending with the line break character.
`int`	`getBaselineAt(int lineIndex)` Returns the baseline of the line at the specified index.
`protected TextPositionInfo`	`getIncompleteTextPositionAt(int textIndex, int lineIndex)` Returns the incomplete text position information from the specified text index and line index.
`protected TextPositionInfo`	`getIncompleteTextPositionNearby(TextPositionInfo posInfo, int textIndex)` Returns the incomplete text position information nearby the specfied text position information at the specified index of the text.
`protected TextPositionInfo`	`getIncompleteTextPositionNearby(TextPositionInfo posInfo, java.awt.Point point)` Returns the incomplete text position information nearby the specfied text position information at the specified location.
`int`	`getLineBeginAt(int lineIndex)` Returns the beginning index of the line at the specified index.
`int`	`getLineCount()` Returns the number of the lines in this text lines.
`int`	`getLineEndAt(int lineIndex)` Returns the ending index of the line at the specified index.
`int`	`getLineIndexNearby(TextPositionInfo posInfo, int textIndex)` Returns the line index nearby the specfied text position information at the specified index of the text.
`protected int`	`getLineIndexNearby(TextPositionInfo posInfo, int textIndex, int textLength)` Returns the line index nearby the specfied text position information at the specified index of the text.
`int`	`getLineIndexNearby(TextPositionInfo posInfo, java.awt.Point point)` Returns the line index nearby the specfied text position information at the specified location.
`int`	`getLineSkipAt(int lineIndex)` Returns the line skip space at the specified line index.
`int`	`getLineTopAt(int lineIndex)` Returns the top position of the line at the specified index.
`int`	`getRemainWidthAt(int lineIndex)` Returns the remaining width of the line at the specified index.
`RichText`	`getRichText()` Returns the rich text to be composed into lines.
`RichTextStyle`	`getRichTextStyle()` Returns the rich text style of this text lines.
`Text`	`getText()` Returns the text to be composed into lines.
`TextLineInfo`	`getTextLineAt(int lineIndex)` Returns the text line information for the line at the specified line index.
`TextLineInfo`	`getTextLineInto(int lineIndex, TextLineInfo lineInfo)` Sets the text line information for the line at the specified line index into the specified text line information object, and returns the text line information object set.
`TextPositionInfo`	`getTextPositionAtLineBegin(int lineIndex)` Returns the text position information at the beginning of the line at the specified line index.
`protected void`	`invalidateLines()` Invalidate lines in this text lines.
`protected boolean`	`isParagraphMark(int lineBegin)` Checks if the encoded beginning index of the line is marked as a paragraph end.
`boolean`	`isParagraphMarkAt(int lineIndex)` Checks if the line at the specified index is a paragraph end.
`boolean`	`isValid()` Checks if the text lines has a valid layout.
`protected void`	`markLineAt(int lineIndex)` Marks the line at the specified index as a paragraph end.
`protected int`	`markLineBegin(int lineBegin, boolean isParagraphMark)` Encodes the specified beginning index of the line so that it is marked as a paragraph end or not, according to the specified boolean.
`void`	`printDebugInfo()` Prints the debbuging information to the `System.out`.
`protected int`	`reComputeRemainWidths(int width)` Recomputes the remaining widths of this text lines with the specified layout width.
`protected void`	`replace(int begin, int end, TextLines textLines)` Replace the lines of this text lines with the specified text lines.
`protected TextLines`	`sublines(int beginIndex, int endIndex)` Returns a new text lines that is a sublines of this text lines.
`protected void`	`unmarkLineAt(int lineIndex)` Unmarks the line at the specified index as no paragraph end.
`protected int`	`unmarkLineBegin(int lineBegin)` Decodes the specified encoded beginning index of the line to the beginning index of the line.
`protected void`	`validateLines()` Validate lines in this text lines.

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - richText
```
protected RichText richText
```
    The rich text to be composed into lines.
  - rtStyle
```
protected RichTextStyle rtStyle
```
    The style for the rich text.
  - layoutHeight
```
protected int layoutHeight
```
    The layout height.
  - lineBegins
```
protected VArray lineBegins
```
    The array for the beginning index of the line.
  - remainWidths
```
protected VArray remainWidths
```
    The array for the remaining width of the line.
  - baselines
```
protected VArray baselines
```
    The array for the baseline of the line. This value used when the rtStyle.variableLineHeight is true.
  - lineTops
```
protected VArray lineTops
```
    The array for the top position of the line. This value used when the rtStyle.variableLineHeight is true.
  - lineHeight
```
protected int lineHeight
```
    The height of all lines. This value used when the rtStyle.variableLineHeight is false.
  - baseline
```
protected int baseline
```
    The baseline of all lines. This value used when the rtStyle.variableLineHeight is false.
- メソッドの詳細
  - getText
```
public final Text getText()
```
    Returns the text to be composed into lines.
  - getRichText
```
public final RichText getRichText()
```
    Returns the rich text to be composed into lines.
  - getRichTextStyle
```
public final RichTextStyle getRichTextStyle()
```
    Returns the rich text style of this text lines.
  - getLineCount
```
public final int getLineCount()
```
    Returns the number of the lines in this text lines.
  - getLineBeginAt
```
public final int getLineBeginAt(int lineIndex)
```
    Returns the beginning index of the line at the specified index.
  - getLineEndAt
```
public final int getLineEndAt(int lineIndex)
```
    Returns the ending index of the line at the specified index.
  - isParagraphMarkAt
```
public final boolean isParagraphMarkAt(int lineIndex)
```
    Checks if the line at the specified index is a paragraph end.
  - getRemainWidthAt
```
public final int getRemainWidthAt(int lineIndex)
```
    Returns the remaining width of the line at the specified index.
  - getLineSkipAt
```
public final int getLineSkipAt(int lineIndex)
```
    Returns the line skip space at the specified line index.
  - getBaselineAt
```
public final int getBaselineAt(int lineIndex)
```
    Returns the baseline of the line at the specified index.
  - getLineTopAt
```
public final int getLineTopAt(int lineIndex)
```
    Returns the top position of the line at the specified index.
  - isValid
```
public boolean isValid()
```
    Checks if the text lines has a valid layout.
  - validateLines
```
protected void validateLines()
```
    Validate lines in this text lines.
  - invalidateLines
```
protected void invalidateLines()
```
    Invalidate lines in this text lines.
  - markLineAt
```
protected final void markLineAt(int lineIndex)
```
    Marks the line at the specified index as a paragraph end.
  - unmarkLineAt
```
protected final void unmarkLineAt(int lineIndex)
```
    Unmarks the line at the specified index as no paragraph end.
  - getTextLineAt
```
public final TextLineInfo getTextLineAt(int lineIndex)
```
    Returns the text line information for the line at the specified line index.
  - getTextLineInto
```
public final TextLineInfo getTextLineInto(int lineIndex,
                                          TextLineInfo lineInfo)
```
    Sets the text line information for the line at the specified line index into the specified text line information object, and returns the text line information object set.
  - getTextPositionAtLineBegin
```
public final TextPositionInfo getTextPositionAtLineBegin(int lineIndex)
```
    Returns the text position information at the beginning of the line at the specified line index.
    
    パラメータ:
    
    lineIndex - the line index.
    
    戻り値:
    
    the text position information.
  - getIncompleteTextPositionAt
```
protected final TextPositionInfo getIncompleteTextPositionAt(int textIndex,
                                                             int lineIndex)
```
    Returns the incomplete text position information from the specified text index and line index. If the text index is less than 0, then the line begin index is used as the text index.
  - append
```
protected final void append(TextLineInfo lineInfo)
```
    Appends the line described in the specified text line information to this text lines.
  - append
```
protected final void append(TextLines textLines)
```
    Appends the specified text lines to this text lines.
  - replace
```
protected final void replace(int begin,
                             int end,
                             TextLines textLines)
```
    Replace the lines of this text lines with the specified text lines.
    
    パラメータ:
    
    begin - the beginning index of the line to replace, inclusive.
    
    end - the ending index of the line to replace, exclusive.
    
    textLines - a replacement TextLines object.
  - sublines
```
protected final TextLines sublines(int beginIndex,
                                   int endIndex)
```
    Returns a new text lines that is a sublines of this text lines. The sublines begins at the specified beginIndex of the line and extends to the line at index endIndex-1.
    
    パラメータ:
    
    beginIndex - the beginning index of the line, inclusive.
    
    endIndex - the ending index of the line, exclusive.
    
    戻り値:
    
    the sublines.
  - doLayoutForEmpty
```
protected final java.awt.Dimension doLayoutForEmpty(int width,
                                                    int lineWrap)
```
    Lays out the empty text lines with the specified width.
    
    パラメータ:
    
    width - the width to lay out.
    
    lineWrap - the line wrapping style.
    
    戻り値:
    
    the layout size.
  - changeRemainWidths
```
protected final void changeRemainWidths(int diff)
```
    Changes the remaining widths of this text lines with the specified difference of the layout width.
  - reComputeRemainWidths
```
protected final int reComputeRemainWidths(int width)
```
    Recomputes the remaining widths of this text lines with the specified layout width.
  - duplicateLastLine
```
protected final int duplicateLastLine(int width,
                                      int lineTop,
                                      boolean endWithBreak)
```
    Duplicates the last line, with the specified length of the text, layout width, the paragraph style of the last line, and flag indicating that the last line is ending with the line break character.
  - getIncompleteTextPositionNearby
```
protected final TextPositionInfo getIncompleteTextPositionNearby(TextPositionInfo posInfo,
                                                                 int textIndex)
```
    Returns the incomplete text position information nearby the specfied text position information at the specified index of the text.
    
    パラメータ:
    
    posInfo - the text position information used as the starting point for searching. If null, the searching starts from the beginning or ending of the layout according to the index of the text.
    
    textIndex - the index of the text to search for.
    
    戻り値:
    
    the incomplete text position information; or null, if this layout does not have a valid layout.
  - getIncompleteTextPositionNearby
```
protected final TextPositionInfo getIncompleteTextPositionNearby(TextPositionInfo posInfo,
                                                                 java.awt.Point point)
```
    Returns the incomplete text position information nearby the specfied text position information at the specified location.
    
    パラメータ:
    
    posInfo - the text position information used as the starting point for searching. If null, the searching starts from the top or bottom of the layout according to the location.
    
    point - the location to search for.
    
    戻り値:
    
    the incomplete text position information; or null, if this layout does not have a valid layout.
  - getLineIndexNearby
```
public final int getLineIndexNearby(TextPositionInfo posInfo,
                                    int textIndex)
```
    Returns the line index nearby the specfied text position information at the specified index of the text.
    
    パラメータ:
    
    posInfo - the text position information used as the starting point for searching. If null, the searching starts from the beginning or ending of the layout according to the index of the text.
    
    textIndex - the index of the text to search for.
    
    戻り値:
    
    the line index; or -1 if this text lines does not have a valid layout.
  - getLineIndexNearby
```
protected final int getLineIndexNearby(TextPositionInfo posInfo,
                                       int textIndex,
                                       int textLength)
```
    Returns the line index nearby the specfied text position information at the specified index of the text.
    
    パラメータ:
    
    posInfo - the text position information used as the starting point for searching. If null, the searching starts from the beginning or ending of the layout according to the index of the text.
    
    textIndex - the index of the text to search for.
    
    textLength - the length of the text.
    
    戻り値:
    
    the line index; or -1 if this text lines does not have a valid layout.
  - getLineIndexNearby
```
public final int getLineIndexNearby(TextPositionInfo posInfo,
                                    java.awt.Point point)
```
    Returns the line index nearby the specfied text position information at the specified location.
    
    パラメータ:
    
    posInfo - the text position information used as the starting point for searching. If null, the searching starts from the top or bottom of the layout according to the location.
    
    point - the location to search for.
    
    戻り値:
    
    the line index; or -1 if this text lines does not have a valid layout.
  - markLineBegin
```
protected final int markLineBegin(int lineBegin,
                                  boolean isParagraphMark)
```
    Encodes the specified beginning index of the line so that it is marked as a paragraph end or not, according to the specified boolean.
    
    関連項目:
    
    unmarkLineBegin(int), isParagraphMark(int)
  - unmarkLineBegin
```
protected final int unmarkLineBegin(int lineBegin)
```
    Decodes the specified encoded beginning index of the line to the beginning index of the line.
    
    関連項目:
    
    markLineBegin(int, boolean), isParagraphMark(int)
  - isParagraphMark
```
protected final boolean isParagraphMark(int lineBegin)
```
    Checks if the encoded beginning index of the line is marked as a paragraph end.
    
    関連項目:
    
    markLineBegin(int, boolean), unmarkLineBegin(int)
  - printDebugInfo
```
public void printDebugInfo()
```
    Prints the debbuging information to the System.out. This method is used for DEBUG.
  - assert
```
protected final void assert(boolean b)
```
    Asserts the given boolean to be true.

クラス TextLines

フィールドのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

richText

rtStyle

layoutHeight

lineBegins

remainWidths

baselines

lineTops

lineHeight

baseline

メソッドの詳細

getText

getRichText

getRichTextStyle

getLineCount

getLineBeginAt

getLineEndAt

isParagraphMarkAt

getRemainWidthAt

getLineSkipAt

getBaselineAt

getLineTopAt

isValid

validateLines

invalidateLines

markLineAt

unmarkLineAt

getTextLineAt

getTextLineInto

getTextPositionAtLineBegin

getIncompleteTextPositionAt

append

append

replace

sublines

doLayoutForEmpty

changeRemainWidths

reComputeRemainWidths

duplicateLastLine

getIncompleteTextPositionNearby

getIncompleteTextPositionNearby

getLineIndexNearby

getLineIndexNearby

getLineIndexNearby

markLineBegin

unmarkLineBegin

isParagraphMark

printDebugInfo

assert