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

Method Summary

Modifier and Type	Method and Description
public default StyleSpans<S>	append(S style, int length) Appends the given style to the end of the list of `StyleSpan`.
public default StyleSpans<S>	append(StyleSpan<S> span) Appends the given style to the end of the list of `StyleSpan`.
public default StyleSpans<S>	concat(StyleSpans<S> that)
public boolean	equals(Object other) Two `StyleSpans` objects are considered equal if they contain equal number of `StyleSpan`s and the `StyleSpan`s are pairwise equal.
public int	getSpanCount()
public IndexRange	Returns: IndexRange relative to start of style spans getStyleRange(int is relative to start of style spans position)
public StyleSpan<S>	getStyleSpan(int index)
public default Iterator<StyleSpan<S>>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.
public int	length()
public default StyleSpans<S>	Returns: StyleSpans with replaced styles. mapStyles(UnaryOperator<S> function to calculate new style mapper) Returns a new `StyleSpans` object that has the same total length as this StyleSpans and style of every span is mapped by the given function.
public default StyleSpans<S>	overlay(StyleSpans<S> that, BiFunction<? super S, ? super S, ? extends S> f) Applies the given bifunction `f` to this object's `StyleSpan` objects and `that` `StyleSpan` objects and stores the result in the returned `StyleSpans` object.
public default StyleSpans<S>	prepend(S style, int length) Prepends the given style to the start of the list of `StyleSpan`.
public default StyleSpans<S>	prepend(StyleSpan<S> span) Prepends the given style to the start of the list of `StyleSpan`.
public static <S> StyleSpans<S>	singleton(S style, int length) Creates a `StyleSpans` object that only contains one `StyleSpan` object.
public static <S> StyleSpans<S>	singleton(StyleSpan<S> span) Creates a `StyleSpans` object that only contains one `StyleSpan` object.
public default Stream<StyleSpan<S>>	stream() Returns a stream of this list' `StyleSpan` objects.
public default Stream<S>	styleStream() Returns a stream of just this list of `StyleSpan`'s styles.
public default StyleSpans<S>	subView(int from, int to) Same as `java.util.List#subList(int, int)`
public default StyleSpans<S>	subView(TwoDimensional.Position from, TwoDimensional.Position to) Same as `java.util.List#subList(int, int)`, except that the arguments are two dimensional.

Inherited from java.lang.Iterable:: forEach spliterator
Inherited from org.fxmisc.richtext.model.TwoDimensional:: offsetToPosition position

Method Detail

append	back to summary
public default StyleSpans<S> append(S style, int length) Appends the given style to the end of the list of `StyleSpan`.

append	back to summary
public default StyleSpans<S> append(StyleSpan<S> span) Appends the given style to the end of the list of `StyleSpan`.

concat	back to summary
public default StyleSpans<S> concat(StyleSpans<S> that)

equals back to summary

equals	back to summary
public boolean equals(Object other) Two `StyleSpans` objects are considered equal if they contain equal number of `StyleSpan`s and the `StyleSpan`s are pairwise equal. Annotations @Override

public boolean equals(Object other)

Two StyleSpans objects are considered equal if they contain equal number of StyleSpans and the StyleSpans are pairwise equal.

Annotations

@Override

getSpanCount	back to summary
public int getSpanCount()

getStyleRange	back to summary
public IndexRange getStyleRange(int position) Parameters position:int is relative to start of style spans Returns:IndexRange IndexRange relative to start of style spans

getStyleSpan	back to summary
public StyleSpan<S> getStyleSpan(int index)

iterator back to summary

iterator	back to summary
public default Iterator<StyleSpan<S>> iterator() Implements java.lang.Iterable.iterator. Doc from java.lang.Iterable.iterator. Returns an iterator over elements of type `T`. Annotations @Override

public default Iterator<StyleSpan<S>> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Annotations

@Override

length	back to summary
public int length()

mapStyles back to summary

mapStyles	back to summary
public default StyleSpans<S> mapStyles(UnaryOperator<S> mapper) Returns a new `StyleSpans` object that has the same total length as this StyleSpans and style of every span is mapped by the given function. Adjacent style spans whose style mapped to the same value are merged into one. As a consequence, the returned StyleSpans might have fewer style spans than this StyleSpans. Parameters mapper:UnaryOperator<S> function to calculate new style Returns:StyleSpans<S> StyleSpans with replaced styles.

public default StyleSpans<S> mapStyles(UnaryOperator<S> mapper)

Returns a new StyleSpans object that has the same total length as this StyleSpans and style of every span is mapped by the given function. Adjacent style spans whose style mapped to the same value are merged into one. As a consequence, the returned StyleSpans might have fewer style spans than this StyleSpans.

Parameters

mapper:UnaryOperator<S>: function to calculate new style

Returns:StyleSpans<S>

StyleSpans with replaced styles.

overlay	back to summary
public default StyleSpans<S> overlay(StyleSpans<S> that, BiFunction<? super S, ? super S, ? extends S> f) Applies the given bifunction `f` to this object's `StyleSpan` objects and `that` `StyleSpan` objects and stores the result in the returned `StyleSpans` object.

prepend	back to summary
public default StyleSpans<S> prepend(S style, int length) Prepends the given style to the start of the list of `StyleSpan`.

prepend	back to summary
public default StyleSpans<S> prepend(StyleSpan<S> span) Prepends the given style to the start of the list of `StyleSpan`.

singleton	back to summary
public static <S> StyleSpans<S> singleton(S style, int length) Creates a `StyleSpans` object that only contains one `StyleSpan` object.

singleton	back to summary
public static <S> StyleSpans<S> singleton(StyleSpan<S> span) Creates a `StyleSpans` object that only contains one `StyleSpan` object.

stream	back to summary
public default Stream<StyleSpan<S>> stream() Returns a stream of this list' `StyleSpan` objects.

styleStream	back to summary
public default Stream<S> styleStream() Returns a stream of just this list of `StyleSpan`'s styles.

subView	back to summary
public default StyleSpans<S> subView(int from, int to) Same as `java.util.List#subList(int, int)`

subView	back to summary
public default StyleSpans<S> subView(TwoDimensional.Position from, TwoDimensional.Position to) Same as `java.util.List#subList(int, int)`, except that the arguments are two dimensional.

public Interface StyleSpans<S>

Method Summary

Method Detail