Package io.keikai.axyra.sheets.content

Record Class CommentRun

java.lang.Object
java.lang.Record
io.keikai.axyra.sheets.content.CommentRun
Record Components:
text - the literal run text
fontName - the font name, or null for the default note font
fontSize - the font size in points, or null for the default
bold - bold
italic - italic
underline - underline
strikethrough - strikethrough
color - the font color as ARGB hex ("FFFF0000"), or null
public record CommentRun(String text, String fontName, Double fontSize, boolean bold, boolean italic, boolean underline, boolean strikethrough, String color) extends Record
One formatted run of a rich-text cell comment (note) — ECMA-376 Part 1 §18.7.7 comment/text/r. Build runs with of(String) and the with… copies: 

 cell.setRichComment("Ann",
         CommentRun.of("Status: "),
         CommentRun.of("APPROVED").withBold().withColor("FF008000"));

  • Constructor Details

    • CommentRun

      public CommentRun(String text, String fontName, Double fontSize, boolean bold, boolean italic, boolean underline, boolean strikethrough, String color)
      Creates an instance of a CommentRun record class.
      Parameters:
      text - the value for the text record component
      fontName - the value for the fontName record component
      fontSize - the value for the fontSize record component
      bold - the value for the bold record component
      italic - the value for the italic record component
      underline - the value for the underline record component
      strikethrough - the value for the strikethrough record component
      color - the value for the color record component

  • Method Details

    • of

      public static CommentRun of(String text)
      A run of text with the default note formatting.

    • withBold

      public CommentRun withBold()
      A copy with bold on.

    • withItalic

      public CommentRun withItalic()
      A copy with italic on.

    • withUnderline

      public CommentRun withUnderline()
      A copy with underline on.

    • withStrikethrough

      public CommentRun withStrikethrough()
      A copy with strikethrough on.

    • withColor

      public CommentRun withColor(String argb)
      A copy with the given ARGB font color ("FFFF0000").

    • withFont

      public CommentRun withFont(String name, Double sizePt)
      A copy with the given font name and size (either may be null).

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • text

      public String text()
      Returns the value of the text record component.
      Returns:
      the value of the text record component

    • fontName

      public String fontName()
      Returns the value of the fontName record component.
      Returns:
      the value of the fontName record component

    • fontSize

      public Double fontSize()
      Returns the value of the fontSize record component.
      Returns:
      the value of the fontSize record component

    • bold

      public boolean bold()
      Returns the value of the bold record component.
      Returns:
      the value of the bold record component

    • italic

      public boolean italic()
      Returns the value of the italic record component.
      Returns:
      the value of the italic record component

    • underline

      public boolean underline()
      Returns the value of the underline record component.
      Returns:
      the value of the underline record component

    • strikethrough

      public boolean strikethrough()
      Returns the value of the strikethrough record component.
      Returns:
      the value of the strikethrough record component

    • color

      public String color()
      Returns the value of the color record component.
      Returns:
      the value of the color record component