RichTextFX 0.11.5 · org.fxmisc.richtext.TextExt · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
private static class	TextExt.StyleableProperties

Modifier and Type	Field and Description
private final StyleableObjectProperty<Paint>	backgroundColor
private final StyleableObjectProperty<Paint>	borderStrokeColor
private final StyleableObjectProperty<Number[]>	borderStrokeDashArray
private final StyleableObjectProperty<StrokeType>	borderStrokeType
private final StyleableObjectProperty<Number>	borderStrokeWidth
private static final List<CssMetaData<? extends Styleable, ?>>	CSS_META_DATA_LIST
private final StyleableObjectProperty<StrokeLineCap>	underlineCap
private final StyleableObjectProperty<Paint>	underlineColor
private final StyleableObjectProperty<Number[]>	underlineDashArray
private final StyleableObjectProperty<Number>	underlineDoubleGap
private final StyleableObjectProperty<Number>	underlineOffset
private final StyleableObjectProperty<Number>	underlineWaveRadius
private final StyleableObjectProperty<Number>	underlineWidth

Constructor Summary

Access	Constructor and Description
public	TextExt(String text)
public	TextExt()

Method Summary

Modifier and Type	Method and Description
public ObjectProperty<Paint>	backgroundColorProperty() The background color of the section of text.
public ObjectProperty<Paint>	borderStrokeColorProperty() The border stroke color of the section of text.
public ObjectProperty<Number[]>	borderStrokeDashArrayProperty() The dash array used for drawing the border for a section of text.
public ObjectProperty<StrokeType>	borderStrokeTypeProperty() The stroke type of the border stroke.
public ObjectProperty<Number>	borderStrokeWidthProperty() The width of the border stroke.
public Paint	getBackgroundColor()
public Paint	getBorderStrokeColor()
public Number[]	getBorderStrokeDashArray()
public StrokeType	getBorderStrokeType()
public Number	getBorderStrokeWidth()
public List<CssMetaData<? extends Styleable, ?>>	getCssMetaData() Overrides javafx.scene.text.Text.getCssMetaData. Implements javafx.css.Styleable.getCssMetaData. This method should delegate to `Node#getClassCssMetaData()` so that a Node's CssMetaData can be accessed without the need for reflection.
public StrokeLineCap	getUnderlineCap()
public Paint	getUnderlineColor()
public Number[]	getUnderlineDashArray()
public Number	getUnderlineDoubleGap()
public Number	getUnderlineOffset()
public Number	getUnderlineWaveRadius()
public Number	getUnderlineWidth()
public void	setBackgroundColor(Paint fill)
public void	setBorderStrokeColor(Paint fill)
public void	setBorderStrokeDashArray(Number[] array)
public void	setBorderStrokeType(StrokeType type)
public void	setBorderStrokeWidth(Number width)
public void	setUnderlineCap(StrokeLineCap cap)
public void	setUnderlineColor(Paint fill)
public void	setUnderlineDashArray(Number[] dashArray)
public void	setUnderlineDoubleGap(Number radius)
public void	setUnderlineOffset(Number width)
public void	setUnderlineWaveRadius(Number radius)
public void	setUnderlineWidth(Number width)
public ObjectProperty<StrokeLineCap>	underlineCapProperty() The end cap style used for drawing each dash in a dashed underline for a section of text.
public ObjectProperty<Paint>	underlineColorProperty() The underline color of the section of text.
public ObjectProperty<Number[]>	underlineDashArrayProperty() The dash array used for drawing the underline for a section of text.
public ObjectProperty<Number>	underlineDoubleGapProperty() The size of the gap between two parallel underline lines or wave forms.
public ObjectProperty<Number>	underlineOffsetProperty() The offset of the underline for a section of text.
public ObjectProperty<Number>	underlineWaveRadiusProperty() The arc radius used to draw a wavy underline.
public ObjectProperty<Number>	underlineWidthProperty() The width of the underline for a section of text.

Inherited from javafx.scene.text.Text:: baselineOffsetProperty boundsTypeProperty caretBiasProperty caretPositionProperty caretShape caretShapeProperty fontProperty fontSmoothingTypeProperty getBaselineOffset getBoundsType getCaretPosition getCaretShape getClassCssMetaData getFont getFontSmoothingType getLineSpacing getSelectionEnd getSelectionFill getSelectionShape getSelectionStart getTabSize getText getTextAlignment getTextOrigin getWrappingWidth getX getY hitTest isCaretBias isStrikethrough isUnderline lineSpacingProperty queryAccessibleAttribute rangeShape selectionEndProperty selectionFillProperty selectionShapeProperty selectionStartProperty setBoundsType setCaretBias setCaretPosition setFont setFontSmoothingType setLineSpacing setSelectionEnd setSelectionFill setSelectionStart setStrikethrough setTabSize setText setTextAlignment setTextOrigin setUnderline setWrappingWidth setX setY strikethroughProperty tabSizeProperty textAlignmentProperty textOriginProperty textProperty toString underlineProperty underlineShape usesMirroring wrappingWidthProperty xProperty yProperty

Field Detail

backgroundColor	back to summary
private final StyleableObjectProperty<Paint> backgroundColor

borderStrokeColor	back to summary
private final StyleableObjectProperty<Paint> borderStrokeColor

borderStrokeDashArray	back to summary
private final StyleableObjectProperty<Number[]> borderStrokeDashArray

borderStrokeType	back to summary
private final StyleableObjectProperty<StrokeType> borderStrokeType

borderStrokeWidth	back to summary
private final StyleableObjectProperty<Number> borderStrokeWidth

CSS_META_DATA_LIST	back to summary
private static final List<CssMetaData<? extends Styleable, ?>> CSS_META_DATA_LIST

underlineCap	back to summary
private final StyleableObjectProperty<StrokeLineCap> underlineCap

underlineColor	back to summary
private final StyleableObjectProperty<Paint> underlineColor

underlineDashArray	back to summary
private final StyleableObjectProperty<Number[]> underlineDashArray

underlineDoubleGap	back to summary
private final StyleableObjectProperty<Number> underlineDoubleGap

underlineOffset	back to summary
private final StyleableObjectProperty<Number> underlineOffset

underlineWaveRadius	back to summary
private final StyleableObjectProperty<Number> underlineWaveRadius

underlineWidth	back to summary
private final StyleableObjectProperty<Number> underlineWidth

Constructor Detail

TextExt	back to summary
public TextExt(String text)

TextExt	back to summary
public TextExt()

Method Detail

backgroundColorProperty	back to summary
public ObjectProperty<Paint> backgroundColorProperty() The background color of the section of text. By default, JavaFX doesn't support a background for Text (as it is a Shape item), but RichTextFX does support drawing a different background for different sections of text. Note that this is actually a Paint type, so you can specify gradient or image fills rather than a flat colour. But due to line wrapping, it's possible that the fill may be used multiple times on separate lines even for the same segment of text. Can be styled from CSS using the "-rtfx-background-color" property.

backgroundColorProperty

back to summary

public ObjectProperty<Paint> backgroundColorProperty()

The background color of the section of text. By default, JavaFX doesn't support a background for Text (as it is a Shape item), but RichTextFX does support drawing a different background for different sections of text.

Note that this is actually a Paint type, so you can specify gradient or image fills rather than a flat colour. But due to line wrapping, it's possible that the fill may be used multiple times on separate lines even for the same segment of text.

Can be styled from CSS using the "-rtfx-background-color" property.

borderStrokeColorProperty back to summary

borderStrokeColorProperty	back to summary
public ObjectProperty<Paint> borderStrokeColorProperty() The border stroke color of the section of text. By default, JavaFX doesn't support a border for Text (as it is a Shape item), but RichTextFX does support drawing a different background for different sections of text. The border will only be drawn if this has a non-null value and `borderStrokeWidthProperty()` a positive value Note that this is actually a Paint type, so you can specify gradient or image fills rather than a flat colour. But due to line wrapping, it's possible that the fill may be used multiple times on separate lines even for the same segment of text. Can be styled from CSS using the "-rtfx-border-stroke-color" property.

public ObjectProperty<Paint> borderStrokeColorProperty()

The border stroke color of the section of text. By default, JavaFX doesn't support a border for Text (as it is a Shape item), but RichTextFX does support drawing a different background for different sections of text. The border will only be drawn if this has a non-null value and borderStrokeWidthProperty() a positive value

Can be styled from CSS using the "-rtfx-border-stroke-color" property.

borderStrokeDashArrayProperty	back to summary
public ObjectProperty<Number[]> borderStrokeDashArrayProperty() The dash array used for drawing the border for a section of text. The border stroke will only be drawn if borderStrokeColorProperty() (which determines the color) has a non-null value. See `borderStrokeColorProperty()` for more details. Can be styled from CSS using the "-rtfx-border-stroke-dash-array" property.

borderStrokeTypeProperty	back to summary
public ObjectProperty<StrokeType> borderStrokeTypeProperty() The stroke type of the border stroke. The border stroke will only be drawn if borderStrokeColorProperty() (which determines the color) has a non-null value. See `borderStrokeColorProperty()` for more details. Can be styled from CSS using the "-rtfx-border-stroke-type" property.

borderStrokeWidthProperty	back to summary
public ObjectProperty<Number> borderStrokeWidthProperty() The width of the border stroke. The border stroke will only be drawn if borderStrokeColorProperty() (which determines the color) has a non-null value. See `borderStrokeColorProperty()` for more details. Can be styled from CSS using the "-rtfx-border-stroke-width" property.

getBackgroundColor	back to summary
public Paint getBackgroundColor()

getBorderStrokeColor	back to summary
public Paint getBorderStrokeColor()

getBorderStrokeDashArray	back to summary
public Number[] getBorderStrokeDashArray()

getBorderStrokeType	back to summary
public StrokeType getBorderStrokeType()

getBorderStrokeWidth	back to summary
public Number getBorderStrokeWidth()

getCssMetaData back to summary

public List<CssMetaData<? extends Styleable, ?>> getCssMetaData()

Overrides javafx.scene.text.Text.getCssMetaData.

Implements javafx.css.Styleable.getCssMetaData.

Doc from javafx.scene.text.Text.getCssMetaData.

This method should delegate to Node#getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.

Annotations

@Override

getUnderlineCap	back to summary
public StrokeLineCap getUnderlineCap()

getUnderlineColor	back to summary
public Paint getUnderlineColor()

getUnderlineDashArray	back to summary
public Number[] getUnderlineDashArray()

getUnderlineDoubleGap	back to summary
public Number getUnderlineDoubleGap()

getUnderlineOffset	back to summary
public Number getUnderlineOffset()

getUnderlineWaveRadius	back to summary
public Number getUnderlineWaveRadius()

getUnderlineWidth	back to summary
public Number getUnderlineWidth()

setBackgroundColor	back to summary
public void setBackgroundColor(Paint fill)

setBorderStrokeColor	back to summary
public void setBorderStrokeColor(Paint fill)

setBorderStrokeDashArray	back to summary
public void setBorderStrokeDashArray(Number[] array)

setBorderStrokeType	back to summary
public void setBorderStrokeType(StrokeType type)

setBorderStrokeWidth	back to summary
public void setBorderStrokeWidth(Number width)

setUnderlineCap	back to summary
public void setUnderlineCap(StrokeLineCap cap)

setUnderlineColor	back to summary
public void setUnderlineColor(Paint fill)

setUnderlineDashArray	back to summary
public void setUnderlineDashArray(Number[] dashArray)

setUnderlineDoubleGap	back to summary
public void setUnderlineDoubleGap(Number radius)

setUnderlineOffset	back to summary
public void setUnderlineOffset(Number width)

setUnderlineWaveRadius	back to summary
public void setUnderlineWaveRadius(Number radius)

setUnderlineWidth	back to summary
public void setUnderlineWidth(Number width)

underlineCapProperty back to summary

underlineCapProperty	back to summary
public ObjectProperty<StrokeLineCap> underlineCapProperty() The end cap style used for drawing each dash in a dashed underline for a section of text. Can be styled from CSS using the "-rtfx-underline-cap" property. Note that the underline properties specified here are orthogonal to the `underlineProperty()` inherited from `Text`. The underline properties defined here in `TextExt` will cause an underline to be drawn if `underlineWidthProperty()` is non-null and greater than zero, regardless of the value of `underlineProperty()`.

public ObjectProperty<StrokeLineCap> underlineCapProperty()

The end cap style used for drawing each dash in a dashed underline for a section of text. Can be styled from CSS using the "-rtfx-underline-cap" property.

Note that the underline properties specified here are orthogonal to the underlineProperty() inherited from Text. The underline properties defined here in TextExt will cause an underline to be drawn if underlineWidthProperty() is non-null and greater than zero, regardless of the value of underlineProperty().

underlineColorProperty back to summary

public ObjectProperty<Paint> underlineColorProperty()

The underline color of the section of text.

Can be styled from CSS using the "-rtfx-underline-color" property (not to be confused with JavaFX's separate "-fx-underline" property).

underlineDashArrayProperty back to summary

public ObjectProperty<Number[]> underlineDashArrayProperty()

The dash array used for drawing the underline for a section of text. Can be styled from CSS using the "-rtfx-underline-dash-array" property.

underlineDoubleGapProperty back to summary

public ObjectProperty<Number> underlineDoubleGapProperty()

The size of the gap between two parallel underline lines or wave forms. If null or zero, the underline will be a single line or wave form. Can be styled from CSS using the "-rtfx-underline-double-gap" property.

underlineOffsetProperty back to summary

public ObjectProperty<Number> underlineOffsetProperty()

The offset of the underline for a section of text. If null or zero, the underline will be drawn along the baseline of the text. Can be styled from CSS using the "-rtfx-underline-offset" property.

underlineWaveRadiusProperty back to summary

public ObjectProperty<Number> underlineWaveRadiusProperty()

The arc radius used to draw a wavy underline. If null or zero, the underline will be a simple line. Can be styled from CSS using the "-rtfx-underline-wave-radius" property.

underlineWidthProperty back to summary

public ObjectProperty<Number> underlineWidthProperty()

The width of the underline for a section of text. If null or zero, the underline will not be drawn. Can be styled from CSS using the "-rtfx-underline-width" property.

Field Detail

BACKGROUND_COLOR	back to summary
private static final CssMetaData<TextExt, Paint> BACKGROUND_COLOR

BORDER_COLOR	back to summary
private static final CssMetaData<TextExt, Paint> BORDER_COLOR

BORDER_DASH_ARRAY	back to summary
private static final CssMetaData<TextExt, Number[]> BORDER_DASH_ARRAY

BORDER_TYPE	back to summary
private static final CssMetaData<TextExt, StrokeType> BORDER_TYPE

BORDER_WIDTH	back to summary
private static final CssMetaData<TextExt, Number> BORDER_WIDTH

UNDERLINE_CAP	back to summary
private static final CssMetaData<TextExt, StrokeLineCap> UNDERLINE_CAP

UNDERLINE_COLOR	back to summary
private static final CssMetaData<TextExt, Paint> UNDERLINE_COLOR

UNDERLINE_DASH_ARRAY	back to summary
private static final CssMetaData<TextExt, Number[]> UNDERLINE_DASH_ARRAY

UNDERLINE_DOUBLE_GAP	back to summary
private static final CssMetaData<TextExt, Number> UNDERLINE_DOUBLE_GAP

UNDERLINE_OFFSET	back to summary
private static final CssMetaData<TextExt, Number> UNDERLINE_OFFSET

UNDERLINE_WAVE_RADIUS	back to summary
private static final CssMetaData<TextExt, Number> UNDERLINE_WAVE_RADIUS

UNDERLINE_WIDTH	back to summary
private static final CssMetaData<TextExt, Number> UNDERLINE_WIDTH

Constructor Detail

StyleableProperties	back to summary
private StyleableProperties()

public Class TextExt

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class TextExt.StyleableProperties

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail