Modifier and Type	Class and Description
public static class	TextLayout.Hit

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGN_CENTER
public static final int	ALIGN_JUSTIFY
public static final int	ALIGN_LEFT
public static final int	ALIGN_MASK
public static final int	ALIGN_RIGHT
public static final int	ANALYSIS_MASK
public static final int	BOUNDS_CENTER
public static final int	BOUNDS_MASK
public static final int	DEFAULT_TAB_SIZE
public static final int	DIRECTION_DEFAULT_LTR
public static final int	DIRECTION_DEFAULT_RTL
public static final int	DIRECTION_LTR
public static final int	DIRECTION_MASK
public static final int	DIRECTION_RTL
public static final int	FLAGS_ANALYSIS_VALID
public static final int	FLAGS_CACHED_STRIKETHROUGH
public static final int	FLAGS_CACHED_UNDERLINE
public static final int	FLAGS_HAS_BIDI
public static final int	FLAGS_HAS_CJK
public static final int	FLAGS_HAS_COMPLEX
public static final int	FLAGS_HAS_EMBEDDED
public static final int	FLAGS_HAS_TABS
public static final int	FLAGS_LAST
public static final int	FLAGS_LINES_VALID
public static final int	FLAGS_RTL_BASE
public static final int	FLAGS_WRAPPED
public static final int	TYPE_BASELINE
public static final int	TYPE_BEARINGS
public static final int	TYPE_STRIKETHROUGH
public static final int	TYPE_TEXT
public static final int	TYPE_TOP
public static final int	TYPE_UNDERLINE

Method Summary

Modifier and Type	Method and Description
public BaseBounds	Returns: the layout bounds getBounds() Returns the (logical) bounds of the layout minX is always zero minY is the ascent of the first line (negative) width the width of the widest line height the sum of all lines height Note that this width is different the wrapping width!
public BaseBounds	getBounds(TextSpan filter, BaseBounds bounds)
public PathElement[]	getCaretShape(int offset, boolean isLeading, float x, float y)
public TextLayout.Hit	getHitInfo(float x, float y)
public TextLine[]	Returns: the text lines getLines() Returns the lines of text layout.
public PathElement[]	getRange(int start, int end, int type, float x, float y)
public GlyphList[]	Returns: the runs getRuns() Returns the GlyphList of text layout.
public Shape	Returns: the shape getShape(int the type of the shapes to include type, TextSpan filter) Returns the shape of the entire text layout relative to the baseline of the first line.
public BaseBounds	Returns: the visual bounds getVisualBounds(int type) Returns the visual bounds of the layout using glyph bounding box
public boolean	Returns: returns true is the call modifies the layout internal state. setAlignment(int alignment) Sets the alignment for the TextLayout.
public boolean	Returns: returns true is the call modifies the layout internal state. setBoundsType(int type) Sets the bounds type for the TextLayout.
public boolean	Returns: returns true is the call modifies the layout internal state. setContent(TextSpan[] spans) Sets the content for the TextLayout.
public boolean	Returns: returns true is the call modifies the layout internal state. setContent(String string, Object font) Sets the content for the TextLayout.
public boolean	Returns: returns true is the call modifies the layout internal state. setDirection(int direction) Sets the direction (bidi algorithm's) for the TextLayout.
public boolean	Returns: returns true is the call modifies the layout internal state. setLineSpacing(float spacing) Sets the line spacing for the TextLayout.
public boolean	Returns: returns true if the call modifies the layout internal state. setTabSize(int the number of spaces represented by a tab. Default is 8. Minimum is 1, lower values will be clamped to 1. spaces) Sets the tab size for the TextLayout.
public boolean	Returns: returns true is the call modifies the layout internal state. setWrapWidth(float wrapWidth) Sets the wrap width for the TextLayout.

Field Detail

ALIGN_CENTER	back to summary
public static final int ALIGN_CENTER

ALIGN_JUSTIFY	back to summary
public static final int ALIGN_JUSTIFY

ALIGN_LEFT	back to summary
public static final int ALIGN_LEFT

ALIGN_MASK	back to summary
public static final int ALIGN_MASK

ALIGN_RIGHT	back to summary
public static final int ALIGN_RIGHT

ANALYSIS_MASK	back to summary
public static final int ANALYSIS_MASK

BOUNDS_CENTER	back to summary
public static final int BOUNDS_CENTER

BOUNDS_MASK	back to summary
public static final int BOUNDS_MASK

DEFAULT_TAB_SIZE	back to summary
public static final int DEFAULT_TAB_SIZE

DIRECTION_DEFAULT_LTR	back to summary
public static final int DIRECTION_DEFAULT_LTR

DIRECTION_DEFAULT_RTL	back to summary
public static final int DIRECTION_DEFAULT_RTL

DIRECTION_LTR	back to summary
public static final int DIRECTION_LTR

DIRECTION_MASK	back to summary
public static final int DIRECTION_MASK

DIRECTION_RTL	back to summary
public static final int DIRECTION_RTL

FLAGS_ANALYSIS_VALID	back to summary
public static final int FLAGS_ANALYSIS_VALID

FLAGS_CACHED_STRIKETHROUGH	back to summary
public static final int FLAGS_CACHED_STRIKETHROUGH

FLAGS_CACHED_UNDERLINE	back to summary
public static final int FLAGS_CACHED_UNDERLINE

FLAGS_HAS_BIDI	back to summary
public static final int FLAGS_HAS_BIDI

FLAGS_HAS_CJK	back to summary
public static final int FLAGS_HAS_CJK

FLAGS_HAS_COMPLEX	back to summary
public static final int FLAGS_HAS_COMPLEX

FLAGS_HAS_EMBEDDED	back to summary
public static final int FLAGS_HAS_EMBEDDED

FLAGS_HAS_TABS	back to summary
public static final int FLAGS_HAS_TABS

FLAGS_LAST	back to summary
public static final int FLAGS_LAST

FLAGS_LINES_VALID	back to summary
public static final int FLAGS_LINES_VALID

FLAGS_RTL_BASE	back to summary
public static final int FLAGS_RTL_BASE

FLAGS_WRAPPED	back to summary
public static final int FLAGS_WRAPPED

TYPE_BASELINE	back to summary
public static final int TYPE_BASELINE

TYPE_BEARINGS	back to summary
public static final int TYPE_BEARINGS

TYPE_STRIKETHROUGH	back to summary
public static final int TYPE_STRIKETHROUGH

TYPE_TEXT	back to summary
public static final int TYPE_TEXT

TYPE_TOP	back to summary
public static final int TYPE_TOP

TYPE_UNDERLINE	back to summary
public static final int TYPE_UNDERLINE

Method Detail

getBounds	back to summary
public BaseBounds getBounds() Returns the (logical) bounds of the layout minX is always zero minY is the ascent of the first line (negative) width the width of the widest line height the sum of all lines height Note that this width is different the wrapping width! Returns:BaseBounds the layout bounds

getBounds

back to summary

public BaseBounds getBounds()

Returns the (logical) bounds of the layout minX is always zero minY is the ascent of the first line (negative) width the width of the widest line height the sum of all lines height Note that this width is different the wrapping width!

Returns:BaseBounds: the layout bounds

getBounds	back to summary
public BaseBounds getBounds(TextSpan filter, BaseBounds bounds)

getCaretShape	back to summary
public PathElement[] getCaretShape(int offset, boolean isLeading, float x, float y)

getHitInfo	back to summary
public TextLayout.Hit getHitInfo(float x, float y)

getLines	back to summary
public TextLine[] getLines() Returns the lines of text layout. Returns:TextLine[] the text lines

getLines

back to summary

public TextLine[] getLines()

Returns the lines of text layout.

Returns:TextLine[]: the text lines

getRange	back to summary
public PathElement[] getRange(int start, int end, int type, float x, float y)

getRuns	back to summary
public GlyphList[] getRuns() Returns the GlyphList of text layout. The runs are returned order visually (rendering order), starting from the first line. Returns:GlyphList[] the runs

getRuns

back to summary

public GlyphList[] getRuns()

Returns the GlyphList of text layout. The runs are returned order visually (rendering order), starting from the first line.

Returns:GlyphList[]: the runs

getShape	back to summary
public Shape getShape(int type, TextSpan filter) Returns the shape of the entire text layout relative to the baseline of the first line. Parameters type:int the type of the shapes to include Returns:Shape the shape

getShape

back to summary

public Shape getShape(int type, TextSpan filter)

Returns the shape of the entire text layout relative to the baseline of the first line.

Parameters

type:int: the type of the shapes to include

Returns:Shape

the shape

getVisualBounds	back to summary
public BaseBounds getVisualBounds(int type) Returns the visual bounds of the layout using glyph bounding box Returns:BaseBounds the visual bounds

getVisualBounds

back to summary

public BaseBounds getVisualBounds(int type)

Returns the visual bounds of the layout using glyph bounding box

Returns:BaseBounds: the visual bounds

setAlignment	back to summary
public boolean setAlignment(int alignment) Sets the alignment for the TextLayout. Returns:boolean returns true is the call modifies the layout internal state.

setAlignment

back to summary

public boolean setAlignment(int alignment)

Sets the alignment for the TextLayout.

Returns:boolean: returns true is the call modifies the layout internal state.

setBoundsType	back to summary
public boolean setBoundsType(int type) Sets the bounds type for the TextLayout. Returns:boolean returns true is the call modifies the layout internal state.

setBoundsType

back to summary

public boolean setBoundsType(int type)

Sets the bounds type for the TextLayout.

Returns:boolean: returns true is the call modifies the layout internal state.

setContent	back to summary
public boolean setContent(TextSpan[] spans) Sets the content for the TextLayout. Supports multiple spans (rich text). Returns:boolean returns true is the call modifies the layout internal state.

setContent

back to summary

public boolean setContent(TextSpan[] spans)

Sets the content for the TextLayout. Supports multiple spans (rich text).

Returns:boolean: returns true is the call modifies the layout internal state.

setContent	back to summary
public boolean setContent(String string, Object font) Sets the content for the TextLayout. Shorthand for single span text (no rich text). Returns:boolean returns true is the call modifies the layout internal state.

setContent

back to summary

public boolean setContent(String string, Object font)

Sets the content for the TextLayout. Shorthand for single span text (no rich text).

Returns:boolean: returns true is the call modifies the layout internal state.

setDirection	back to summary
public boolean setDirection(int direction) Sets the direction (bidi algorithm's) for the TextLayout. Returns:boolean returns true is the call modifies the layout internal state.

setDirection

back to summary

public boolean setDirection(int direction)

Sets the direction (bidi algorithm's) for the TextLayout.

Returns:boolean: returns true is the call modifies the layout internal state.

setLineSpacing	back to summary
public boolean setLineSpacing(float spacing) Sets the line spacing for the TextLayout. Returns:boolean returns true is the call modifies the layout internal state.

setLineSpacing

back to summary

public boolean setLineSpacing(float spacing)

Sets the line spacing for the TextLayout.

Returns:boolean: returns true is the call modifies the layout internal state.

setTabSize

back to summary

public boolean setTabSize(int spaces)

Sets the tab size for the TextLayout.

Parameters

spaces:int: the number of spaces represented by a tab. Default is 8. Minimum is 1, lower values will be clamped to 1.

Returns:boolean

returns true if the call modifies the layout internal state.

setWrapWidth

back to summary

public boolean setWrapWidth(float wrapWidth)

Sets the wrap width for the TextLayout.

Returns:boolean: returns true is the call modifies the layout internal state.

com.sun.javafx.scene.text back to summary

public Class TextLayout.Hit

Class Inheritance

extends Object

java.lang.Object
com.sun.javafx.scene.text.TextLayout.Hit

Field Summary

Modifier and Type	Field and Description
pack-priv int	charIndex
pack-priv int	insertionIndex
pack-priv boolean	leading

Constructor Summary

Access	Constructor and Description
public	Hit(int charIndex, int insertionIndex, boolean leading)

Method Summary

Modifier and Type	Method and Description
public int	getCharIndex()
public int	getInsertionIndex()
public boolean	isLeading()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

charIndex	back to summary
pack-priv int charIndex

insertionIndex	back to summary
pack-priv int insertionIndex

leading	back to summary
pack-priv boolean leading

Constructor Detail

Hit	back to summary
public Hit(int charIndex, int insertionIndex, boolean leading)

Method Detail

getCharIndex	back to summary
public int getCharIndex()

getInsertionIndex	back to summary
public int getInsertionIndex()

isLeading	back to summary
public boolean isLeading()

public Interface TextLayout

Nested and Inner Type Summary

Field Summary

Method Summary

Field Detail

Method Detail

public Class TextLayout.Hit

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail