Package io.keikai.axyra.sheets.content

Class RichText

java.lang.Object

io.keikai.axyra.sheets.content.RichText

public final class RichText
extends Object

Rich (multi-run) cell text — a sequence of runs, each with its own optional font overrides (bold, italic, underline, strike, name, size, color). Apply with Cell.setRichText(...); read back with Cell.richText() and inspect the runs via run(int) / runs(). Crosses the boundary as a JSON array.

 cell.setRichText(RichText.builder()
         .run("Total: ")
         .run("42", RichText.run().bold().color(Color.RED))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RichText.Builder	Fluent builder for a rich-text value.
static final class	RichText.Run	Per-run font overrides, created with run().
static final record	RichText.RunInfo	A read-back view of one run: its text plus the font overrides it carries.

Method Summary

Modifier and Type	Method	Description
static RichText.Builder	builder()	A builder; add runs in reading order with RichText.Builder.run(String).
static RichText	fromJson(String json)	Rebuild from the engine's read-back JSON (see Cell.richText()).
static RichText.Run	run()	A per-run style spec (see RichText.Run).
RichText.RunInfo	run(int index)	The run at index as a typed view.
int	runCount()	Number of runs.
List<RichText.RunInfo>	runs()	Every run as a typed view, in order.
String	text()	The flat cell text — the concatenation of every run's text.
RichText.Builder	toBuilder()	A builder pre-loaded with this text's runs, for read–modify–write round-trips.
String	toJson()	The runs as a JSON array crossed to the engine.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static RichText.Builder builder()

A builder; add runs in reading order with RichText.Builder.run(String).

toBuilder

public RichText.Builder toBuilder()

A builder pre-loaded with this text's runs, for read–modify–write round-trips.

run

public static RichText.Run run()

A per-run style spec (see RichText.Run).

toJson

public String toJson()

The runs as a JSON array crossed to the engine.

fromJson

public static RichText fromJson(String json)

Rebuild from the engine's read-back JSON (see Cell.richText()).

runCount

public int runCount()

Number of runs.

text

public String text()

The flat cell text — the concatenation of every run's text.

run

public RichText.RunInfo run(int index)

The run at index as a typed view.

Parameters:

index - 0-based run index

Throws:

IndexOutOfBoundsException - if index is outside [0, runCount())

runs

public List<RichText.RunInfo> runs()

Every run as a typed view, in order.