Package org.fxmisc.richtext.model

Interface SegmentOps<SEG,S>

Type Parameters:

SEG - The segment type

S - The style type for the segment

All Known Subinterfaces:

TextOps<SEG,S>

All Known Implementing Classes:

NodeSegmentOpsBase, SegmentOpsBase, TextOpsBase

public interface SegmentOps<SEG,S>

Defines the operations which are supported on a specific segment type.

Method Summary

Modifier and Type	Method	Description
char	charAt(SEG seg, int index)
SEG	createEmptySeg()	Creates an empty segment.
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.
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.
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.
String	getText(SEG seg)
Optional<SEG>	joinSeg(SEG currentSeg, SEG nextSeg)	Joins two consecutive segments together into one or Optional.empty() if they cannot be joined.
default Optional<S>	joinStyle(S currentStyle, S nextStyle)	Joins two consecutive styles together into one or Optional.empty() if they cannot be joined.
int	length(SEG seg)
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.
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.
static <S> TextOps<String,S>	styledTextOps()	Creates a TextOps specified for a String segment that never merges consecutive styles
static <S> TextOps<String,S>	styledTextOps(BiFunction<S,S,Optional<S>> mergeStyle)	Creates a TextOps specified for a String
SEG	subSequence(SEG seg, int start)
SEG	subSequence(SEG seg, int start, int end)

Method Detail

length

int length(SEG seg)

charAt

char charAt(SEG seg,
            int index)

getText

String getText(SEG seg)

subSequence

SEG subSequence(SEG seg,
                int start,
                int end)

subSequence

SEG subSequence(SEG seg,
                int start)

joinSeg

Optional<SEG> joinSeg(SEG currentSeg,
                      SEG nextSeg)

Joins two consecutive segments together into one or Optional.empty() if they cannot be joined.

joinStyle

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().

createEmptySeg

SEG createEmptySeg()

Creates an empty segment. This method should return the same object for better performance and memory usage.

styledTextOps

static <S> TextOps<String,S> styledTextOps()

Creates a TextOps specified for a String segment that never merges consecutive styles

styledTextOps

static <S> TextOps<String,S> styledTextOps(BiFunction<S,S,Optional<S>> mergeStyle)

Creates a TextOps specified for a String

or

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

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.

eitherStyles

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.

either

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

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.