org.umber.crucible.old.layout.style
Interface TextStyle

All Known Subinterfaces:
AllStyle
All Known Implementing Classes:
DatumStyleWrapper, DefaultStyle, StyleChain

public interface TextStyle

The size and alignment info for a block of text. The text elements might have varying FontStyle's, but the TextStyle determines how the text in this block is treated as a unit. All values in this style can be accessed through the generic methods in RenderStyle, but convenience methods make this access cleaner and more type-safe.

Author:
jsheets

Field Summary
static int WRAP_CHARACTER
          Text should be wrapped at the character boundary
static java.lang.String[] WRAP_ENUM
          Enumeration of text wrapping
static int WRAP_LINE
          Text should be wrapped at the line boundary
static int WRAP_NEVER
          Text should not be wrapped at all
static int WRAP_PHRASE
          Text should be wrapped at the phrase boundary
static int WRAP_SENTENCE
          Text should be wrapped at the sentence boundary
static int WRAP_WORD
          Text should be wrapped at the word boundary
 
Method Summary
 FontStyle getDefaultFont()
          Returns the default FontStyle of this text.
 int getFirstLineIndent()
          Returns the first line indent property of this text.
 int getWrap()
          Returns the wrap style of this text, according to the WRAP_xxx enumeration.
 

Field Detail

WRAP_NEVER

public static final int WRAP_NEVER
Text should not be wrapped at all

See Also:
Constant Field Values

WRAP_CHARACTER

public static final int WRAP_CHARACTER
Text should be wrapped at the character boundary

See Also:
Constant Field Values

WRAP_WORD

public static final int WRAP_WORD
Text should be wrapped at the word boundary

See Also:
Constant Field Values

WRAP_PHRASE

public static final int WRAP_PHRASE
Text should be wrapped at the phrase boundary

See Also:
Constant Field Values

WRAP_SENTENCE

public static final int WRAP_SENTENCE
Text should be wrapped at the sentence boundary

See Also:
Constant Field Values

WRAP_LINE

public static final int WRAP_LINE
Text should be wrapped at the line boundary

See Also:
Constant Field Values

WRAP_ENUM

public static final java.lang.String[] WRAP_ENUM
Enumeration of text wrapping

Method Detail

getDefaultFont

public FontStyle getDefaultFont()
Returns the default FontStyle of this text.

Returns:
the default FontStyle for this text

getWrap

public int getWrap()
Returns the wrap style of this text, according to the WRAP_xxx enumeration. The behavior of phrase and sentence wrapping may be dependent on the nature of the text.

Returns:
the wrap style

getFirstLineIndent

public int getFirstLineIndent()
Returns the first line indent property of this text.

Returns:
the first line indent value for this text