RichTextStyle (kfc 1.2.0 API)

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

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

java.io.Serializable, java.lang.Cloneable
```
public class RichTextStyle
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable
```
The RichTextStyle implements the style for the rich text object. The rich text style has following attributes:

Line wrapping style
The line wrapping style; one of CHAR_WRAP, WORD_WRAP and NO_WRAP.
Line end style
The line end style; one of JAVA_LINE_SEPARATOR, JAVA_LINE_SEPARATOR_WITH_BREAK and LIST_SEPARATOR.
Variable line height
The flag determining the line height of the rich text is variable.
Text style
The default text style for the rich text.
Paragraph style
The default paragraph style for the rich text.
Tab width
The default tab width for the rich text. The tab width is automatically computed by multiplying a width of space character with the default text style by ParagraphStyle.HARD_TAB_LENGTH.

The rich text style is immutable.

関連項目:

RichText, TextLayout, TextScanner, 直列化された形式

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static int`	`CHAR_WRAP` The constant for the character line wrapping style.
`static RichTextStyle`	`DEFAULT_CODE_STYLE` The default rich text style constant for coding.
`static RichTextStyle`	`DEFAULT_DOCUMENT_STYLE` The default rich text style constant for documenting.
`static RichTextStyle`	`DEFAULT_LIST_STYLE` The default rich text style constant for documenting.
`static int`	`JAVA_LINE_SEPARATOR` The constant for the java line end style.
`static int`	`JAVA_LINE_SEPARATOR_WITH_BREAK` The constant for the java line end style with line break.
`protected int`	`lineEnd` The line end style.
`protected int`	`lineWrap` The line wrapping style.
`static int`	`LIST_SEPARATOR` The constant for the list line end style.
`static int`	`NO_WRAP` The constant for the no line wrapping style.
`protected ParagraphStyle`	`paragraphStyle` The default paragraph style for the rich text.
`protected int`	`tabWidth` The default tab width.
`protected TextStyle`	`textStyle` The default text style for the rich text.
`protected boolean`	`variableLineHeight` True if the line height of the rich text is variable (True if multiple paragraph styles are allowed).
`static int`	`WORD_WRAP` The constant for the word line wrapping style.

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

コンストラクタ
コンストラクタと説明
`RichTextStyle(int lineWrap)` Constructs a rich text style with the specified line wrapping style.
`RichTextStyle(int lineWrap, boolean variableLineHeight)` Constructs a rich text style with the specified line wrapping style and flag determining the line height is variable.
`RichTextStyle(int lineWrap, int lineEnd, boolean variableLineHeight)` Constructs a rich text style with the specified line wrapping style, line end style and flag determining the line height is variable.
`RichTextStyle(int lineWrap, int lineEnd, boolean variableLineHeight, TextStyle textStyle, ParagraphStyle paragraphStyle)` Constructs a rich text style with the specified line wrapping style, line end style, flag determining the line height is variable, default text style and default paragraph style.

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`java.lang.Object`	`clone()` Returns a clone of this rich text style.
`RichTextStyle`	`deriveStyle(int lineWrap, int lineEnd)` Creates a new style by replicating this style with a new line wrapping style and line end style associated with it.
`RichTextStyle`	`deriveStyle(ParagraphStyle paragraphStyle)` Creates a new style by replicating this style with a new paragraph style object associated with it.
`RichTextStyle`	`deriveStyle(TextStyle textStyle)` Creates a new style by replicating this style with a new text style object associated with it.
`boolean`	`equals(java.lang.Object anObject)` Compares two objects for equality.
`int`	`getLineEnd()` Returns the line end style.
`char`	`getLineEndChar()` Returns the line end character.
`int`	`getLineWrap()` Returns the line wrapping style.
`ParagraphStyle`	`getParagraphStyle()` Returns the default paragraph style for the rich text.
`int`	`getTabWidth()` Returns the default tab width.
`TextStyle`	`getTextStyle()` Returns the default text style for the rich text.
`boolean`	`handleBreak()` Checks if the line break is handled.
`int`	`hashCode()` Returns a hashcode of this rich text style.
`boolean`	`isCharWrap()` Checks if the line wrapping style is the character line wrapping style.
`boolean`	`isJavaLineSeparator()` Checks if the line end style is the java line end style.
`boolean`	`isJavaLineSeparatorWithBreak()` Checks if the line end style is the java line end style with line break.
`boolean`	`isListSeparator()` Checks if the line end style is the list line end style.
`boolean`	`isNoWrap()` Checks if the line wrapping style is the no line wrapping style.
`boolean`	`isVariableLineHeight()` Checks if the line height of the rich text is variable.
`boolean`	`isWordWrap()` Checks if the line wrapping style is the word line wrapping style.
`boolean`	`multipleParagraphStylesAllowed()` Checks if multiple paragraph styles are allowed.
`protected void`	`setLineEnd(int lineEnd)` Sets the line end style.
`protected void`	`setLineWrap(int lineWrap)` Sets the line wrapping style.
`java.lang.String`	`toString()` Returns the string representation of this rich text style.

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

- フィールドの詳細
  - lineWrap
```
protected int lineWrap
```
    The line wrapping style.
  - lineEnd
```
protected int lineEnd
```
    The line end style.
  - variableLineHeight
```
protected boolean variableLineHeight
```
    True if the line height of the rich text is variable (True if multiple paragraph styles are allowed).
  - textStyle
```
protected TextStyle textStyle
```
    The default text style for the rich text.
  - paragraphStyle
```
protected ParagraphStyle paragraphStyle
```
    The default paragraph style for the rich text.
  - tabWidth
```
protected int tabWidth
```
    The default tab width.
  - CHAR_WRAP
```
public static final int CHAR_WRAP
```
    The constant for the character line wrapping style.
    The line is wrapped at the character boundary. This style is suited for coding.
    
    関連項目:
    
    定数フィールド値
  - WORD_WRAP
```
public static final int WORD_WRAP
```
    The constant for the word line wrapping style.
    The line is wrapped at the word boundary. This style is suited for documenting.
    
    関連項目:
    
    定数フィールド値
  - NO_WRAP
```
public static final int NO_WRAP
```
    The constant for the no line wrapping style.
    The line is wrapped only at the line separator.
    
    関連項目:
    
    Text.LINE_SEPARATOR_CHAR, 定数フィールド値
  - JAVA_LINE_SEPARATOR
```
public static final int JAVA_LINE_SEPARATOR
```
    The constant for the java line end style.
    That is the paragraph is separated by the Text.LINE_SEPARATOR_CHAR.
    
    関連項目:
    
    Text.LINE_SEPARATOR_CHAR, TextScanner, TextScanner.JAVA_STOPS, 定数フィールド値
  - JAVA_LINE_SEPARATOR_WITH_BREAK
```
public static final int JAVA_LINE_SEPARATOR_WITH_BREAK
```
    The constant for the java line end style with line break.
    That is the paragraph is separated by the Text.LINE_SEPARATOR_CHAR and the line is broken by the Text.LINE_BREAK_CHAR.
    
    関連項目:
    
    Text.LINE_SEPARATOR_CHAR, Text.LINE_BREAK_CHAR, TextScanner, TextScanner.JAVA_BREAK_STOPS, 定数フィールド値
  - LIST_SEPARATOR
```
public static final int LIST_SEPARATOR
```
    The constant for the list line end style.
    That is the paragraph (list item) is separated by the Text.LIST_SEPARATOR_CHAR.
    
    関連項目:
    
    Text.LIST_SEPARATOR_CHAR, TextScanner.LIST_STOPS, TextListView, 定数フィールド値
  - DEFAULT_CODE_STYLE
```
public static final RichTextStyle DEFAULT_CODE_STYLE
```
    The default rich text style constant for coding.
  - DEFAULT_DOCUMENT_STYLE
```
public static final RichTextStyle DEFAULT_DOCUMENT_STYLE
```
    The default rich text style constant for documenting.
  - DEFAULT_LIST_STYLE
```
public static final RichTextStyle DEFAULT_LIST_STYLE
```
    The default rich text style constant for documenting.
- コンストラクタの詳細
  - RichTextStyle
```
public RichTextStyle(int lineWrap)
```
    Constructs a rich text style with the specified line wrapping style.
    
    パラメータ:
    
    lineWrap - the line wrapping style.
  - RichTextStyle
```
public RichTextStyle(int lineWrap,
                     boolean variableLineHeight)
```
    Constructs a rich text style with the specified line wrapping style and flag determining the line height is variable.
    
    パラメータ:
    
    lineWrap - the line wrapping style.
    
    variableLineHeight - the flag determining the line height is variable.
  - RichTextStyle
```
public RichTextStyle(int lineWrap,
                     int lineEnd,
                     boolean variableLineHeight)
```
    Constructs a rich text style with the specified line wrapping style, line end style and flag determining the line height is variable.
    
    パラメータ:
    
    lineWrap - the line wrapping style.
    
    lineEnd - the line end style.
    
    variableLineHeight - the flag determining the line height is variable.
  - RichTextStyle
```
public RichTextStyle(int lineWrap,
                     int lineEnd,
                     boolean variableLineHeight,
                     TextStyle textStyle,
                     ParagraphStyle paragraphStyle)
```
    Constructs a rich text style with the specified line wrapping style, line end style, flag determining the line height is variable, default text style and default paragraph style.
    
    パラメータ:
    
    lineWrap - the line wrapping style.
    
    lineEnd - the line end style.
    
    variableLineHeight - the flag determining the line height is variable.
    
    textStyle - the default text style.
    
    paragraphStyle - the default paragraph style.
- メソッドの詳細
  - getLineWrap
```
public final int getLineWrap()
```
    Returns the line wrapping style.
    
    関連項目:
    
    CHAR_WRAP, WORD_WRAP, NO_WRAP
  - getLineEnd
```
public final int getLineEnd()
```
    Returns the line end style.
    
    関連項目:
    
    JAVA_LINE_SEPARATOR, JAVA_LINE_SEPARATOR_WITH_BREAK, LIST_SEPARATOR
  - getLineEndChar
```
public final char getLineEndChar()
```
    Returns the line end character.
    
    関連項目:
    
    Text.LINE_SEPARATOR_CHAR, Text.LIST_SEPARATOR_CHAR
  - isVariableLineHeight
```
public final boolean isVariableLineHeight()
```
    Checks if the line height of the rich text is variable.
  - multipleParagraphStylesAllowed
```
public final boolean multipleParagraphStylesAllowed()
```
    Checks if multiple paragraph styles are allowed.
  - getTextStyle
```
public final TextStyle getTextStyle()
```
    Returns the default text style for the rich text.
  - getParagraphStyle
```
public final ParagraphStyle getParagraphStyle()
```
    Returns the default paragraph style for the rich text.
  - getTabWidth
```
public int getTabWidth()
```
    Returns the default tab width.
  - isCharWrap
```
public final boolean isCharWrap()
```
    Checks if the line wrapping style is the character line wrapping style.
    
    関連項目:
    
    getLineWrap(), CHAR_WRAP
  - isWordWrap
```
public final boolean isWordWrap()
```
    Checks if the line wrapping style is the word line wrapping style.
    
    関連項目:
    
    getLineWrap(), WORD_WRAP
  - isNoWrap
```
public final boolean isNoWrap()
```
    Checks if the line wrapping style is the no line wrapping style.
    
    関連項目:
    
    getLineWrap(), NO_WRAP
  - isJavaLineSeparator
```
public final boolean isJavaLineSeparator()
```
    Checks if the line end style is the java line end style.
    
    関連項目:
    
    getLineEnd(), JAVA_LINE_SEPARATOR
  - isJavaLineSeparatorWithBreak
```
public final boolean isJavaLineSeparatorWithBreak()
```
    Checks if the line end style is the java line end style with line break.
    
    関連項目:
    
    getLineEnd(), JAVA_LINE_SEPARATOR_WITH_BREAK
  - isListSeparator
```
public final boolean isListSeparator()
```
    Checks if the line end style is the list line end style.
    
    関連項目:
    
    getLineEnd(), LIST_SEPARATOR
  - handleBreak
```
public final boolean handleBreak()
```
    Checks if the line break is handled.
    
    関連項目:
    
    isJavaLineSeparatorWithBreak(), JAVA_LINE_SEPARATOR_WITH_BREAK
  - deriveStyle
```
public RichTextStyle deriveStyle(int lineWrap,
                                 int lineEnd)
```
    Creates a new style by replicating this style with a new line wrapping style and line end style associated with it.
    
    パラメータ:
    
    lineWrap - the line wrapping style for the new style.
    
    lineEnd - the line end style for the new style.
    
    戻り値:
    
    a new style.
  - deriveStyle
```
public RichTextStyle deriveStyle(TextStyle textStyle)
```
    Creates a new style by replicating this style with a new text style object associated with it.
    
    パラメータ:
    
    textStyle - the text style object for the new style.
    
    戻り値:
    
    a new style.
  - deriveStyle
```
public RichTextStyle deriveStyle(ParagraphStyle paragraphStyle)
```
    Creates a new style by replicating this style with a new paragraph style object associated with it.
    
    パラメータ:
    
    paragraphStyle - the paragraph style object for the new style.
    
    戻り値:
    
    a new style.
  - hashCode
```
public int hashCode()
```
    Returns a hashcode of this rich text style.
    
    オーバーライド:
    
    hashCode クラス内 java.lang.Object
  - equals
```
public boolean equals(java.lang.Object anObject)
```
    Compares two objects for equality.
    
    オーバーライド:
    
    equals クラス内 java.lang.Object
  - clone
```
public java.lang.Object clone()
```
    Returns a clone of this rich text style.
    
    オーバーライド:
    
    clone クラス内 java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Returns the string representation of this rich text style.
    
    オーバーライド:
    
    toString クラス内 java.lang.Object
  - setLineWrap
```
protected void setLineWrap(int lineWrap)
```
    Sets the line wrapping style.
  - setLineEnd
```
protected void setLineEnd(int lineEnd)
```
    Sets the line end style.

クラス RichTextStyle

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

lineWrap

lineEnd

variableLineHeight

textStyle

paragraphStyle

tabWidth

CHAR_WRAP

WORD_WRAP

NO_WRAP

JAVA_LINE_SEPARATOR

JAVA_LINE_SEPARATOR_WITH_BREAK

LIST_SEPARATOR

DEFAULT_CODE_STYLE

DEFAULT_DOCUMENT_STYLE

DEFAULT_LIST_STYLE

コンストラクタの詳細

RichTextStyle

RichTextStyle

RichTextStyle

RichTextStyle

メソッドの詳細

getLineWrap

getLineEnd

getLineEndChar

isVariableLineHeight

multipleParagraphStylesAllowed

getTextStyle

getParagraphStyle

getTabWidth

isCharWrap

isWordWrap

isNoWrap

isJavaLineSeparator

isJavaLineSeparatorWithBreak

isListSeparator

handleBreak

deriveStyle

deriveStyle

deriveStyle

hashCode

equals

clone

toString

setLineWrap

setLineEnd