Package org.fxmisc.richtext.model

Class SegmentOpsBase<SEG,S>

java.lang.Object

org.fxmisc.richtext.model.SegmentOpsBase<SEG,S>

Type Parameters:

SEG - the type of segment

S - the type of style

All Implemented Interfaces:

SegmentOps<SEG,S>

Direct Known Subclasses:

NodeSegmentOpsBase, TextOpsBase

public abstract class SegmentOpsBase<SEG,S>
extends java.lang.Object
implements SegmentOps<SEG,S>

Provides a base for properly implementing the SegmentOps interface and reduces boilerplate, so that a developer only needs to implement methods for real segments, not empty ones. Optionally, SegmentOps.joinSeg(Object, Object) and joinStyle(Object, Object) can be overridden as well.

Constructor Summary

Constructors

Constructor	Description
SegmentOpsBase(SEG emptySeg)	Creates a SegmentOpsBase that returns emptySeg every time an empty segment should be returned

Method Summary

Modifier and Type	Method	Description
char	charAt(SEG seg, int index)
SEG	createEmptySeg()	Creates an empty segment.
java.lang.String	getText(SEG seg)
java.util.Optional<S>	joinStyle(S currentStyle, S nextStyle)	Joins two consecutive styles together into one or Optional.empty() if they cannot be joined.
abstract char	realCharAt(SEG seg, int index)
abstract java.lang.String	realGetText(SEG seg)
SEG	realSubSequence(SEG seg, int start)
abstract SEG	realSubSequence(SEG seg, int start, int end)
SEG	subSequence(SEG seg, int start)
SEG	subSequence(SEG seg, int start, int end)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.fxmisc.richtext.model.SegmentOps

joinSeg, length, or, orStyled

Constructor Detail

SegmentOpsBase

public SegmentOpsBase(SEG emptySeg)

Creates a SegmentOpsBase that returns emptySeg every time an empty segment should be returned

Method Detail

charAt

public final char charAt(SEG seg,
                         int index)

Specified by:

charAt in interface SegmentOps<SEG,S>

realCharAt

public abstract char realCharAt(SEG seg,
                                int index)

getText

public final java.lang.String getText(SEG seg)

Specified by:

getText in interface SegmentOps<SEG,S>

realGetText

public abstract java.lang.String realGetText(SEG seg)

subSequence

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

Specified by:

subSequence in interface SegmentOps<SEG,S>

realSubSequence

public abstract SEG realSubSequence(SEG seg,
                                    int start,
                                    int end)

subSequence

public final SEG subSequence(SEG seg,
                             int start)

Specified by:

subSequence in interface SegmentOps<SEG,S>

realSubSequence

public SEG realSubSequence(SEG seg,
                           int start)

createEmptySeg

public final SEG createEmptySeg()

Description copied from interface: SegmentOps

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

Specified by:

createEmptySeg in interface SegmentOps<SEG,S>

joinStyle

public java.util.Optional<S> joinStyle(S currentStyle,
                                       S nextStyle)

Description copied from interface: SegmentOps

Joins two consecutive styles together into one or Optional.empty() if they cannot be joined. By default, returns Optional.empty().

Specified by:

joinStyle in interface SegmentOps<SEG,S>