Class RichParagraph.Builder
java.lang.Object
jfx.incubator.scene.control.richtext.model.RichParagraph.Builder
-
Method Summary
Modifier and TypeMethodDescriptionaddHighlight
(int start, int length, Color color) Adds a color background highlight.addInlineNode
(Supplier<Node> generator) Adds an inline node.addSegment
(String text) Adds a text segment with no styling (i.e.addSegment
(String text, int start, int end, StyleAttributeMap attrs) Adds a styled text segment.addSegment
(String text, StyleAttributeMap attrs) Adds a styled text segment.addWavyUnderline
(int start, int length, Color color) Adds a wavy underline (typically used as a spell checker indicator) with the given color.addWithInlineAndStyleNames
(String text, String style, String... css) Appends a text segment styled with both the inline style and the stylesheet style names.addWithInlineStyle
(String text, String style) Appends a text segment styled with the stylesheet style names.addWithStyleNames
(String text, String... css) Appends a text segment styled with the stylesheet style names.build()
Creates an instance of immutableRichParagraph
from information in thisBuilder
.Sets the paragraph attributes.
-
Method Details
-
addWavyUnderline
Adds a wavy underline (typically used as a spell checker indicator) with the given color.- Parameters:
start
- the start offsetlength
- the end offsetcolor
- the background color- Returns:
- this
Builder
instance
-
addSegment
Adds a text segment with no styling (i.e. using default style). This convenience method is equivalent to callingaddSegment(text, StyleAttributeMap.EMPTY);
- Parameters:
text
- the text to append, must not contain\n
, cannot be null- Returns:
- this
Builder
instance
-
addWithStyleNames
Appends a text segment styled with the stylesheet style names.- Parameters:
text
- non-null text stringcss
- array of style names, cannot be null- Returns:
- this
Builder
instance
-
addWithInlineAndStyleNames
Appends a text segment styled with both the inline style and the stylesheet style names.- Parameters:
text
- non-null text stringstyle
- direct style (such as-fx-fill:red;
), or nullcss
- array of style names- Returns:
- this
Builder
instance
-
addWithInlineStyle
Appends a text segment styled with the stylesheet style names.- Parameters:
text
- non-null text stringstyle
- the inline style (example"-fx-fill:red;"
), or null- Returns:
- this
Builder
instance
-
addSegment
Adds a styled text segment.- Parameters:
text
- the text to append, must not contain\n
, cannot be nullattrs
- the styled attributes, cannot be null- Returns:
- this
Builder
instance
-
addSegment
Adds a styled text segment.- Parameters:
text
- the source non-null stringstart
- the start offset of the input stringend
- the end offset of the input stringattrs
- the styled attributes- Returns:
- this
Builder
instance
-
addHighlight
Adds a color background highlight. Use translucent colors to enable multiple highlights in the same region of text.- Parameters:
start
- the start offsetlength
- the end offsetcolor
- the background color- Returns:
- this
Builder
instance
-
addInlineNode
Adds an inline node.The supplied generator must not cache or keep reference to the created Node, but the created Node can keep a reference to the model or some property therein.
For example, a bidirectional binding between an inline control and some property in the model would synchronize the model with all the views that use it.
- Parameters:
generator
- the generator that provides the actualNode
- Returns:
- this
Builder
instance
-
setParagraphAttributes
Sets the paragraph attributes.- Parameters:
a
- the paragraph attributes- Returns:
- this
Builder
instance
-
build
Creates an instance of immutableRichParagraph
from information in thisBuilder
.- Returns:
- the new paragraph instance
-