Class RubySpan


  • public final class RubySpan
    extends Object
    A styling span for ruby text.

    The text covered by this span is known as the "base text", and the ruby text is stored in rubyText.

    More information on ruby characters and span styling.

    • Field Detail

      • POSITION_UNKNOWN

        public static final int POSITION_UNKNOWN
        The ruby position is unknown.
        See Also:
        Constant Field Values
      • POSITION_OVER

        public static final int POSITION_OVER
        The ruby text should be positioned above the base text.

        For vertical text it should be positioned to the right, same as CSS's ruby-position.

        See Also:
        Constant Field Values
      • POSITION_UNDER

        public static final int POSITION_UNDER
        The ruby text should be positioned below the base text.

        For vertical text it should be positioned to the left, same as CSS's ruby-position.

        See Also:
        Constant Field Values
      • rubyText

        public final String rubyText
        The ruby text, i.e. the smaller explanatory characters.
      • position

        @Position
        public final int position
        The position of the ruby text relative to the base text.
    • Constructor Detail