Class InterElementAttribute

  • All Implemented Interfaces:
    Attribute

    public final class InterElementAttribute
    extends java.lang.Object
    implements Attribute
    This class defines attributes which can be placed between elements on AttributedRuns.

    In addition to defining the type for inter element attribute keys, this class defines a number of well-known inter element attributes, and in particular all the attributes which are exchanged between an inline formatter and its clients. For each such attribute, we define the possible values.

    Other InterElementAttribute objects can be created and used by the client of an inline formatter. However, these keys will be ignored by the inline formatters of this package.

    Concurrency

    Instances of this class are immutable after construction and contain no mutable static data. Therefore, they are threadsafe.
    • Constructor Summary

      Constructors 
      Constructor Description
      InterElementAttribute​(java.lang.String name)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • ligatureLevel

        public static final InterElementAttribute ligatureLevel
        The maximimum level of ligature crossing this inter element boundary. The value must be a LigatureLevel; see that class for the ordering.

        If the character stream contains explicit indications about ligatures (e.g. if U+200C ZERO WIDTH NON-JOINER or U+200D ZERO WIDTH JOINER is present), then those indications override precedence over this attribute. The interpretation of those characters in terms of ligature levels depend on the script, but they are always equivalent to the smallest level (LigatureLevel.NONE) or the highest level (LigatureLevel.COMMON).

    • Constructor Detail

      • InterElementAttribute

        public InterElementAttribute​(java.lang.String name)
    • Method Detail

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object