RichText (kfc 1.2.0 API)

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

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

java.io.Serializable, java.lang.Cloneable

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

HTMLText
```
public class RichText
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable
```
The RichText class implements a text with paragraph styles. The principal operations on a RichText are the replace, setTextStyle, modifyTextStyle, setParagraphStyle, modifyParagraphStyle, and print methods:
- The replace method replaces the specified range of the rich text with the specified replacement text and returns the TextChange object.
- The setTextStyle method sets the text style in the specified range of the rich text to be the specified text style and returns the TextChange object.
- The modifyTextStyle method modifies the text style in the specified range of the rich text by using the specified TextStyleModifier object and returns the TextChange object.
- The setParagraphStyle method sets the paragraph style at the specified range of the rich text to be the specified paragraph style and returns the TextChange object.
- The modifyParagraphStyle method modifies the paragraph style at the specified range of the rich text by using the specified ParagraphStyleModifier object and returns the TextChange object.
- The print method prints the rich text to a print device provided from the specified PrintJob object.
The RichText object is laid out (composed) into the lines by a TextLayout object. The TextLayout object composes the RichText object into multiple paragraphs that are separated by the line end character (RichTextStyle.getLineEndChar()). Each paragraph has its own paragraph style, if the RichTextStyle.multipleParagraphStylesAllowed() is true. The RichText object in the paragraph is composed into multiple lines that are broken at the layout width.
関連項目:

TextStyle, TextStyleModifier, ParagraphStyle, ParagraphStyleModifier, TextChange, TextLayout, 直列化された形式

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static java.awt.Insets`	`DEFAULT_PRINT_INSETS` The constant for the default insets of the printing medium (paper).
`protected RunArray`	`paragraphStyles` The paragraph styles.
`protected RichTextStyle`	`rtStyle` The style of the rich text.
`protected Text`	`text` The text of the rich text.
`protected TextStyleModifier`	`textStyleConstraint` The text style constraint.

コンストラクタのサマリー

コンストラクタ
修飾子	コンストラクタと説明
`protected`	`RichText(RichText richText)` Constructs a rich text that has the same contents as the specified rich text.
	`RichText(RichTextStyle rtStyle)` Constructs an empty rich text with the specified rich text style.
	`RichText(java.lang.String string, RichTextStyle rtStyle)` Constructs a rich text with the specified string and rich text style.
	`RichText(Text text, RichTextStyle rtStyle)` Constructs a rich text with the specified text and rich text style.
`protected`	`RichText(Text text, RichTextStyle rtStyle, RunArray paragraphStyles)` Constructs a rich text with the specified text, rich text style, and paragraph styles.

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`java.lang.Object`	`clone()` Returns a clone of this rich text.
`TextAttachment`	`getAttachmentAt(int textIndex)` Returns the text attachment at the specified index.
`int`	`getAttachmentCount()` Returns the number of the text attachments in this rich text.
`char`	`getChar(int textIndex)` Returns the character at the specified index.
`java.text.CharacterIterator`	`getCharacterIterator()` Returns the character iterator for this text.
`java.text.CharacterIterator`	`getCharacterIterator(int pos)` Returns the character iterator for this text, with the specified initial index.
`java.text.CharacterIterator`	`getCharacterIterator(int begin, int end, int pos)` Returns the character iterator for this text, with the specified range and initial index.
`ParagraphStyle`	`getParagraphStyleAt(int textIndex)` Returns the paragraph style at the specified index.
`int`	`getParagraphStyleCount()` Returns the number of the paragraph styles in this rich text.
`RunArray`	`getParagraphStyleRuns()` Returns the paragraph styles as a run array in this rich text.
`ParagraphStyle[]`	`getParagraphStyles()` Returns all paragraph styles in this rich text.
`ParagraphStyle[]`	`getParagraphStyles(int begin, int end)` Returns the paragraph styles in this rich text.
`ParagraphStyle[]`	`getParagraphStylesPerParagraph(int begin, int end)` Returns the paragraph styles in this rich text per paragraph.
`RichTextStyle`	`getRichTextStyle()` Returns the `RichTextStyle` object of this rich text.
`Text`	`getText()` Returns the `Text` object in this rich text.
`TextStyle`	`getTextStyleAt(int textIndex)` Returns the text style at the specified index.
`TextStyleModifier`	`getTextStyleConstraint()` Returns the text style constraint of this rich text.
`int`	`getTextStyleCount()` Returns the number of the text styles in this rich text.
`RunArray`	`getTextStyleRuns()` Returns the text styles as a run array in this rich text.
`TextStyle[]`	`getTextStyles()` Returns all text styles in this rich text.
`TextStyle[]`	`getTextStyles(int begin, int end)` Returns the text styles in this rich text.
`boolean`	`isEmpty()` Tests if this rich text has no characters.
`int`	`length()` Returns the length of this rich text.
`TextChange`	`modifyParagraphStyle(int begin, int end, ParagraphStyleModifier modifier)`
`TextChange`	`modifyTextStyle(int begin, int end, TextStyleModifier modifier)`
`int`	`nextParagraphBeginIndexOf(int fromIndex)` Returns the index of the next paragraph begin, starting the search at the specified index.
`int`	`paragraphBeginIndexOf(int fromIndex)` Returns the index of the paragraph begin, searching backward starting at the specified index.
`int`	`paragraphEndIndexOf(int fromIndex)` Returns the index of the paragraph end, starting the search at the specified index.
`java.util.Enumeration`	`paragraphStyles()` Returns an enumeration of the paragraph styles of this text.
`java.util.Enumeration`	`paragraphStyles(int begin, int end)` Returns an enumeration of the paragraph styles of this text.
`void`	`print(java.awt.PrintJob job)` Prints the rich text to a print device provided from the specified print job.
`void`	`print(java.awt.PrintJob job, java.awt.Insets insets, int lineWrap, java.lang.String header, boolean printPageNum)` Prints the rich text to a print device provided from the specified print job, with the specified insets, line wrapping, header string, and flag determining to print a page number in footer.
`void`	`print(java.awt.PrintJob job, java.awt.Insets insets, int lineWrap, java.lang.String header, boolean printPageNum, java.awt.Font headerFooterFont, java.awt.Color foreground)` Prints the rich text to a print device provided from the specified print job, with the specified insets, line wrapping, header string, flag determining to print a page number in footer, font for the header/footer, and foreground printing color.
`void`	`print(java.awt.PrintJob job, java.lang.String header, boolean printPageNum)` Prints the rich text to a print device provided from the specified print job, with the specified header string and flag determining to print a page number in footer.
`TextChange`	`replace(int begin, int end, RichText rep)` Replaces the specified range of this rich text with the specified replacement rich text object.
`TextChange`	`replace(int begin, int end, Text rep)` Replaces the specified range of this rich text with the specified replacement text object.
`TextChange`	`setBaseTextStyle(TextStyle textStyle)` Sets the base text style of this rich text to be the specified text style.
`TextChange`	`setParagraphStyle(int begin, int end, ParagraphStyle pStyle)`
`TextChange`	`setParagraphStyles(int begin, int end, ParagraphStyle[] pStyles)`
`TextChange`	`setTextStyle(int begin, int end, TextStyle textStyle)`
`void`	`setTextStyleConstraint(TextStyleModifier constraint)` Sets the text style constraint of this rich text to be the specified text style modifier.
`TextChange`	`setTextStyles(int begin, int end, RunArray textStyles)`
`RichText`	`subtext(int begin, int end)` Returns a new rich text that is a subtext of this rich text.
`java.util.Enumeration`	`textStyles()` Returns an enumeration of the text styles of this text.
`java.util.Enumeration`	`textStyles(int begin, int end)` Returns an enumeration of the text styles of this text.

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

- フィールドの詳細
  - text
```
protected Text text
```
    The text of the rich text.
  - rtStyle
```
protected RichTextStyle rtStyle
```
    The style of the rich text.
  - paragraphStyles
```
protected RunArray paragraphStyles
```
    The paragraph styles.
  - textStyleConstraint
```
protected transient TextStyleModifier textStyleConstraint
```
    The text style constraint.
  - DEFAULT_PRINT_INSETS
```
public static final java.awt.Insets DEFAULT_PRINT_INSETS
```
    The constant for the default insets of the printing medium (paper).
- コンストラクタの詳細
  - RichText
```
public RichText(RichTextStyle rtStyle)
```
    Constructs an empty rich text with the specified rich text style.
    
    パラメータ:
    
    rtStyle - the rich text style.
  - RichText
```
public RichText(java.lang.String string,
                RichTextStyle rtStyle)
```
    Constructs a rich text with the specified string and rich text style.
    
    パラメータ:
    
    string - the initial string.
    
    rtStyle - the rich text style.
  - RichText
```
public RichText(Text text,
                RichTextStyle rtStyle)
```
    Constructs a rich text with the specified text and rich text style.
    
    パラメータ:
    
    text - the initial text.
    
    rtStyle - the rich text style.
  - RichText
```
protected RichText(RichText richText)
```
    Constructs a rich text that has the same contents as the specified rich text.
    
    パラメータ:
    
    richText - the rich text.
  - RichText
```
protected RichText(Text text,
                   RichTextStyle rtStyle,
                   RunArray paragraphStyles)
```
    Constructs a rich text with the specified text, rich text style, and paragraph styles.
    
    パラメータ:
    
    text - the text.
    
    rtStyle - the rich text style.
    
    paragraphStyles - the paragraph style.
- メソッドの詳細
  - getText
```
public final Text getText()
```
    Returns the Text object in this rich text. An application should not modify the returned text.
  - getRichTextStyle
```
public final RichTextStyle getRichTextStyle()
```
    Returns the RichTextStyle object of this rich text.
  - isEmpty
```
public final boolean isEmpty()
```
    Tests if this rich text has no characters.
    
    戻り値:
    
    true if this text has no characters; false otherwise.
    
    関連項目:
    
    Text.isEmpty()
  - length
```
public final int length()
```
    Returns the length of this rich text.
    
    関連項目:
    
    Text.length()
  - getChar
```
public final char getChar(int textIndex)
```
    Returns the character at the specified index.
    
    パラメータ:
    
    index - an index into this rich text.
    
    戻り値:
    
    the character at the specified index.
    
    関連項目:
    
    Text.getChar(int)
  - getCharacterIterator
```
public final java.text.CharacterIterator getCharacterIterator()
```
    Returns the character iterator for this text.
    
    戻り値:
    
    the character iterator for this text.
  - getCharacterIterator
```
public final java.text.CharacterIterator getCharacterIterator(int pos)
```
    Returns the character iterator for this text, with the specified initial index.
    
    パラメータ:
    
    pos - initial iterator position.
    
    戻り値:
    
    the character iterator for this text.
  - getCharacterIterator
```
public final java.text.CharacterIterator getCharacterIterator(int begin,
                                                              int end,
                                                              int pos)
```
    Returns the character iterator for this text, with the specified range and initial index.
    
    パラメータ:
    
    begin - index of the first character.
    
    end - index of the character following the last character.
    
    pos - initial iterator position.
    
    戻り値:
    
    the character iterator for this text.
  - textStyles
```
public final java.util.Enumeration textStyles()
```
    Returns an enumeration of the text styles of this text.
    
    戻り値:
    
    an enumeration of the text styles of this text.
  - textStyles
```
public final java.util.Enumeration textStyles(int begin,
                                              int end)
```
    Returns an enumeration of the text styles of this text.
    
    パラメータ:
    
    begin - the beginning index to get styles, inclusive.
    
    end - the ending index to get styles, exclusive.
    
    戻り値:
    
    an enumeration of the text styles of this text.
  - getTextStyleRuns
```
public final RunArray getTextStyleRuns()
```
    Returns the text styles as a run array in this rich text. An application should not modify the returned run array.
    
    関連項目:
    
    Text.getTextStyleRuns()
  - getTextStyleAt
```
public final TextStyle getTextStyleAt(int textIndex)
```
    Returns the text style at the specified index.
    
    パラメータ:
    
    index - an index into this rich text.
    
    戻り値:
    
    the text style at the specified index.
    
    関連項目:
    
    jp.kyasu.graphics.Text#getTextStyleAt()
  - getTextStyleCount
```
public final int getTextStyleCount()
```
    Returns the number of the text styles in this rich text.
    
    関連項目:
    
    Text.getTextStyleCount()
  - getTextStyles
```
public final TextStyle[] getTextStyles()
```
    Returns all text styles in this rich text.
    
    関連項目:
    
    Text.getTextStyles()
  - getTextStyles
```
public final TextStyle[] getTextStyles(int begin,
                                       int end)
```
    Returns the text styles in this rich text.
    
    パラメータ:
    
    begin - the beginning index to get text styles, inclusive.
    
    end - the ending index to get text styles, exclusive.
    
    戻り値:
    
    the text styles in this rich text.
    
    関連項目:
    
    Text.getTextStyles(int, int)
  - getAttachmentAt
```
public final TextAttachment getAttachmentAt(int textIndex)
```
    Returns the text attachment at the specified index.
    
    パラメータ:
    
    index - an index into this rich text.
    
    戻り値:
    
    the text attachment if this rich text contains the text attachment at the specified index; null otherwise.
    
    関連項目:
    
    Text.getAttachmentAt(int)
  - getAttachmentCount
```
public final int getAttachmentCount()
```
    Returns the number of the text attachments in this rich text.
    
    関連項目:
    
    Text.getAttachmentCount()
  - paragraphStyles
```
public final java.util.Enumeration paragraphStyles()
```
    Returns an enumeration of the paragraph styles of this text.
    
    戻り値:
    
    an enumeration of the paragraph styles of this text.
  - paragraphStyles
```
public final java.util.Enumeration paragraphStyles(int begin,
                                                   int end)
```
    Returns an enumeration of the paragraph styles of this text.
    
    パラメータ:
    
    begin - the beginning index to get styles, inclusive.
    
    end - the ending index to get styles, exclusive.
    
    戻り値:
    
    an enumeration of the paragraph styles of this text.
  - getParagraphStyleRuns
```
public final RunArray getParagraphStyleRuns()
```
    Returns the paragraph styles as a run array in this rich text. An application should not modify the returned run array.
  - getParagraphStyleAt
```
public final ParagraphStyle getParagraphStyleAt(int textIndex)
```
    Returns the paragraph style at the specified index.
    
    パラメータ:
    
    index - an index into this rich text.
    
    戻り値:
    
    the paragraph style at the specified index.
  - getParagraphStyleCount
```
public final int getParagraphStyleCount()
```
    Returns the number of the paragraph styles in this rich text.
  - getParagraphStyles
```
public final ParagraphStyle[] getParagraphStyles()
```
    Returns all paragraph styles in this rich text.
  - getParagraphStyles
```
public final ParagraphStyle[] getParagraphStyles(int begin,
                                                 int end)
```
    Returns the paragraph styles in this rich text.
    
    パラメータ:
    
    begin - the beginning index of the text to get paragraph styles, inclusive.
    
    end - the ending index of the text to get paragraph styles, exclusive.
  - getParagraphStylesPerParagraph
```
public final ParagraphStyle[] getParagraphStylesPerParagraph(int begin,
                                                             int end)
```
    Returns the paragraph styles in this rich text per paragraph.
    
    パラメータ:
    
    begin - the beginning index of the text to get paragraph styles, inclusive.
    
    end - the ending index of the text to get paragraph styles, exclusive.
  - subtext
```
public RichText subtext(int begin,
                        int end)
```
    Returns a new rich text that is a subtext of this rich text.
    
    パラメータ:
    
    begin - the beginning index, inclusive.
    
    end - the ending index, exclusive.
    
    戻り値:
    
    the subtext.
  - paragraphBeginIndexOf
```
public final int paragraphBeginIndexOf(int fromIndex)
```
    Returns the index of the paragraph begin, searching backward starting at the specified index.
    
    パラメータ:
    
    fromIndex - the index to start the search from.
    
    戻り値:
    
    the index of the the paragraph begin, inclusive.
  - paragraphEndIndexOf
```
public final int paragraphEndIndexOf(int fromIndex)
```
    Returns the index of the paragraph end, starting the search at the specified index.
    
    パラメータ:
    
    fromIndex - the index to start the search from.
    
    戻り値:
    
    the index of the paragraph end, inclusive.
  - nextParagraphBeginIndexOf
```
public final int nextParagraphBeginIndexOf(int fromIndex)
```
    Returns the index of the next paragraph begin, starting the search at the specified index.
    
    パラメータ:
    
    fromIndex - the index to start the search from.
    
    戻り値:
    
    the index of the next paragraph end, or -1 if the paragraph is last one.
  - setBaseTextStyle
```
public TextChange setBaseTextStyle(TextStyle textStyle)
```
    Sets the base text style of this rich text to be the specified text style.
    
    パラメータ:
    
    textStyle - the text style.
    
    戻り値:
    
    the TextChange object that provides an information of changes in this rich text made by this method.
  - getTextStyleConstraint
```
public TextStyleModifier getTextStyleConstraint()
```
    Returns the text style constraint of this rich text.
    
    戻り値:
    
    the text style constraint of this rich text.
    
    関連項目:
    
    setTextStyleConstraint(jp.kyasu.graphics.TextStyleModifier)
  - setTextStyleConstraint
```
public void setTextStyleConstraint(TextStyleModifier constraint)
```
    Sets the text style constraint of this rich text to be the specified text style modifier.
    
    パラメータ:
    
    constraint - the text style modifier.
    
    関連項目:
    
    getTextStyleConstraint()
  - clone
```
public java.lang.Object clone()
```
    Returns a clone of this rich text.
    
    オーバーライド:
    
    clone クラス内 java.lang.Object
  - replace
```
public TextChange replace(int begin,
                          int end,
                          Text rep)
```
    Replaces the specified range of this rich text with the specified replacement text object.
    
    パラメータ:
    
    begin - the beginning text position to replace, inclusive.
    
    end - the ending text position to replace, exclusive.
    
    rep - a replacement Text object.
    
    戻り値:
    
    the TextChange object that provides an information of changes in this rich text made by this method.
  - replace
```
public TextChange replace(int begin,
                          int end,
                          RichText rep)
```
    Replaces the specified range of this rich text with the specified replacement rich text object.
    
    パラメータ:
    
    begin - the beginning text position to replace, inclusive.
    
    end - the ending text position to replace, exclusive.
    
    rep - a replacement RichText object.
    
    戻り値:
    
    the TextChange object that provides an information of changes in this rich text made by this method.
  - setTextStyle
```
public TextChange setTextStyle(int begin,
                               int end,
                               TextStyle textStyle)
```
  - setTextStyles
```
public TextChange setTextStyles(int begin,
                                int end,
                                RunArray textStyles)
```
  - modifyTextStyle
```
public TextChange modifyTextStyle(int begin,
                                  int end,
                                  TextStyleModifier modifier)
```
  - setParagraphStyle
```
public TextChange setParagraphStyle(int begin,
                                    int end,
                                    ParagraphStyle pStyle)
```
  - setParagraphStyles
```
public TextChange setParagraphStyles(int begin,
                                     int end,
                                     ParagraphStyle[] pStyles)
```
  - modifyParagraphStyle
```
public TextChange modifyParagraphStyle(int begin,
                                       int end,
                                       ParagraphStyleModifier modifier)
```
  - print
```
public void print(java.awt.PrintJob job)
```
    Prints the rich text to a print device provided from the specified print job.
    
    パラメータ:
    
    job - the print job.
  - print
```
public void print(java.awt.PrintJob job,
                  java.lang.String header,
                  boolean printPageNum)
```
    Prints the rich text to a print device provided from the specified print job, with the specified header string and flag determining to print a page number in footer.
    
    パラメータ:
    
    job - the print job.
    
    header - the header string.
    
    printPageNum - if true, prints a page number in footer.
  - print
```
public void print(java.awt.PrintJob job,
                  java.awt.Insets insets,
                  int lineWrap,
                  java.lang.String header,
                  boolean printPageNum)
```
    Prints the rich text to a print device provided from the specified print job, with the specified insets, line wrapping, header string, and flag determining to print a page number in footer.
    
    パラメータ:
    
    job - the print job.
    
    insets - the insets of a printing medium (paper).
    
    lineWrap - the line wrapping style.
    
    header - the header string.
    
    printPageNum - if true, prints a page number in footer.
  - print
```
public void print(java.awt.PrintJob job,
                  java.awt.Insets insets,
                  int lineWrap,
                  java.lang.String header,
                  boolean printPageNum,
                  java.awt.Font headerFooterFont,
                  java.awt.Color foreground)
```
    Prints the rich text to a print device provided from the specified print job, with the specified insets, line wrapping, header string, flag determining to print a page number in footer, font for the header/footer, and foreground printing color.
    
    パラメータ:
    
    job - the print job.
    
    insets - the insets of a printing medium (paper).
    
    lineWrap - the line wrapping style.
    
    header - the header string.
    
    printPageNum - if true, prints a page number in footer.
    
    headerFooterFont - the font for the header and footer.
    
    foreground - the foreground printing color.

クラス RichText

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

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

フィールドの詳細

text

rtStyle

paragraphStyles

textStyleConstraint

DEFAULT_PRINT_INSETS

コンストラクタの詳細

RichText

RichText

RichText

RichText

RichText

メソッドの詳細

getText

getRichTextStyle

isEmpty

length

getChar

getCharacterIterator

getCharacterIterator

getCharacterIterator

textStyles

textStyles

getTextStyleRuns

getTextStyleAt

getTextStyleCount

getTextStyles

getTextStyles

getAttachmentAt

getAttachmentCount

paragraphStyles

paragraphStyles

getParagraphStyleRuns

getParagraphStyleAt

getParagraphStyleCount

getParagraphStyles

getParagraphStyles

getParagraphStylesPerParagraph

subtext

paragraphBeginIndexOf

paragraphEndIndexOf

nextParagraphBeginIndexOf

setBaseTextStyle

getTextStyleConstraint

setTextStyleConstraint

clone

replace

replace

setTextStyle

setTextStyles

modifyTextStyle

setParagraphStyle

setParagraphStyles

modifyParagraphStyle

print

print

print

print