RichTextFX 0.11.5 · org.fxmisc.richtext.model.SegmentOps

Method Summary

Modifier and Type	Method and Description
public char	charAt(SEG seg, int index)
public SEG	createEmptySeg() Creates an empty segment.
public static <LSeg, RSeg, Style> SegmentOps<Either<LSeg, RSeg>, Style>	either(SegmentOps<LSeg, Style> lOps, SegmentOps<RSeg, Style> rOps) Returns a `SegmentOps` that specifies its segment type to be an `Either` whose `left` value is `lOps`' segment type and whose `right` value is `rOps`' segment type.
public static <LSeg, RSeg, Style> SegmentOps<Either<LSeg, RSeg>, Style>	either(SegmentOps<LSeg, Style> lOps, SegmentOps<RSeg, Style> rOps, BiFunction<Style, Style, Optional<Style>> mergeStyle) Returns a `SegmentOps` that specifies its segment type to be an `Either` whose `left` value is `lOps`' segment type and whose `right` value is `rOps`' segment type.
public static <LSeg, LStyle, RSeg, RStyle> SegmentOps<Either<LSeg, RSeg>, Either<LStyle, RStyle>>	eitherStyles(SegmentOps<LSeg, LStyle> lOps, SegmentOps<RSeg, RStyle> rOps) Returns a `SegmentOps` that specifies its segment type to be an `Either` whose `left` value is `lOps`' segment type and whose `right` value is `rOps`' segment type, and that specifies its style type to be `Either` whose `left` value is `lOps`' style type and whose `right` value is `rOps`' style type.
public String	getText(SEG seg)
public Optional<SEG>	joinSeg(SEG currentSeg, SEG nextSeg) Joins two consecutive segments together into one or `Optional#empty()` if they cannot be joined.
public default Optional<S>	joinStyle(S currentStyle, S nextStyle) Joins two consecutive styles together into one or `Optional#empty()` if they cannot be joined.
public int	length(SEG seg)
public default <R> SegmentOps<Either<SEG, R>, S>	or(SegmentOps<R, S> rOps) Returns a `SegmentOps` that specifies its segment type to be an `Either` whose `left` value is this segment type and whose `right` value is `rOps`' segment type.
public default <RSeg, RStyle> SegmentOps<Either<SEG, RSeg>, Either<S, RStyle>>	orStyled(SegmentOps<RSeg, RStyle> rOps) Returns a `SegmentOps` that specifies its segment type to be an `Either` whose `left` value is this segment type and whose `right` value is `rOps`' segment type, and that specifies its style type to be `Either` whose `left` value is this style type and whose `right` value is `rOps`' style type.
public static <S> TextOps<String, S>	styledTextOps() Creates a `TextOps` specified for a `String` segment that never merges consecutive styles
public static <S> TextOps<String, S>	styledTextOps(BiFunction<S, S, Optional<S>> mergeStyle) Creates a `TextOps` specified for a `String`
public SEG	subSequence(SEG seg, int start, int end)
public SEG	subSequence(SEG seg, int start)

Method Detail

charAt	back to summary
public char charAt(SEG seg, int index)

createEmptySeg	back to summary
public SEG createEmptySeg() Creates an empty segment. This method should return the same object for better performance and memory usage.

either	back to summary
public static <LSeg, RSeg, Style> SegmentOps<Either<LSeg, RSeg>, Style> either(SegmentOps<LSeg, Style> lOps, SegmentOps<RSeg, Style> rOps) Returns a `SegmentOps` that specifies its segment type to be an `Either` whose `left` value is `lOps`' segment type and whose `right` value is `rOps`' segment type. Note consecutive styles will not be merged.

either	back to summary
public static <LSeg, RSeg, Style> SegmentOps<Either<LSeg, RSeg>, Style> either(SegmentOps<LSeg, Style> lOps, SegmentOps<RSeg, Style> rOps, BiFunction<Style, Style, Optional<Style>> mergeStyle) Returns a `SegmentOps` that specifies its segment type to be an `Either` whose `left` value is `lOps`' segment type and whose `right` value is `rOps`' segment type.

eitherStyles back to summary

eitherStyles	back to summary
public static <LSeg, LStyle, RSeg, RStyle> SegmentOps<Either<LSeg, RSeg>, Either<LStyle, RStyle>> eitherStyles(SegmentOps<LSeg, LStyle> lOps, SegmentOps<RSeg, RStyle> rOps) Returns a `SegmentOps` that specifies its segment type to be an `Either` whose `left` value is `lOps`' segment type and whose `right` value is `rOps`' segment type, and that specifies its style type to be `Either` whose `left` value is `lOps`' style type and whose `right` value is `rOps`' style type. Note consecutive styles will not be merged.

public static <LSeg, LStyle, RSeg, RStyle> SegmentOps<Either<LSeg, RSeg>, Either<LStyle, RStyle>> eitherStyles(SegmentOps<LSeg, LStyle> lOps, SegmentOps<RSeg, RStyle> rOps)

Returns a SegmentOps that specifies its segment type to be an Either whose left value is lOps' segment type and whose right value is rOps' segment type, and that specifies its style type to be Either whose left value is lOps' style type and whose right value is rOps' style type.

Note

consecutive styles will not be merged.

getText	back to summary
public String getText(SEG seg)

joinSeg	back to summary
public Optional<SEG> joinSeg(SEG currentSeg, SEG nextSeg) Joins two consecutive segments together into one or `Optional#empty()` if they cannot be joined.

joinStyle	back to summary
public default Optional<S> joinStyle(S currentStyle, S nextStyle) Joins two consecutive styles together into one or `Optional#empty()` if they cannot be joined. By default, returns `Optional#empty()`.

length	back to summary
public int length(SEG seg)

or	back to summary
public default <R> SegmentOps<Either<SEG, R>, S> or(SegmentOps<R, S> rOps) Returns a `SegmentOps` that specifies its segment type to be an `Either` whose `left` value is this segment type and whose `right` value is `rOps`' segment type.

orStyled back to summary

orStyled	back to summary
public default <RSeg, RStyle> SegmentOps<Either<SEG, RSeg>, Either<S, RStyle>> orStyled(SegmentOps<RSeg, RStyle> rOps) Returns a `SegmentOps` that specifies its segment type to be an `Either` whose `left` value is this segment type and whose `right` value is `rOps`' segment type, and that specifies its style type to be `Either` whose `left` value is this style type and whose `right` value is `rOps`' style type.

public default <RSeg, RStyle> SegmentOps<Either<SEG, RSeg>, Either<S, RStyle>> orStyled(SegmentOps<RSeg, RStyle> rOps)

Returns a SegmentOps that specifies its segment type to be an Either whose left value is this segment type and whose right value is rOps' segment type, and that specifies its style type to be Either whose left value is this style type and whose right value is rOps' style type.

styledTextOps	back to summary
public static <S> TextOps<String, S> styledTextOps() Creates a `TextOps` specified for a `String` segment that never merges consecutive styles

styledTextOps	back to summary
public static <S> TextOps<String, S> styledTextOps(BiFunction<S, S, Optional<S>> mergeStyle) Creates a `TextOps` specified for a `String`

subSequence	back to summary
public SEG subSequence(SEG seg, int start, int end)

subSequence	back to summary
public SEG subSequence(SEG seg, int start)

public Interface SegmentOps<SEG, S>

Method Summary

Method Detail