Annotation
open class Annotation
kotlin.Any | |
↳ | java.text.Annotation |
An Annotation object is used as a wrapper for a text attribute value if the attribute has annotation characteristics. These characteristics are:
- The text range that the attribute is applied to is critical to the semantics of the range. That means, the attribute cannot be applied to subranges of the text range that it applies to, and, if two adjacent text ranges have the same value for this attribute, the attribute still cannot be applied to the combined range as a whole with this value.
- The attribute or its value usually do no longer apply if the underlying text is changed.
Wrapping the attribute value into an Annotation object guarantees that adjacent text runs don't get merged even if the attribute values are equal, and indicates to text containers that the attribute should be discarded if the underlying text is modified.
Summary
Public constructors | |
---|---|
Annotation(value: Any!) Constructs an annotation record with the given value, which may be null. |
Public methods | |
---|---|
open Any! |
getValue() Returns the value of the attribute, which may be null. |
open String |
toString() Returns the String representation of this Annotation. |
Public constructors
Annotation
Annotation(value: Any!)
Constructs an annotation record with the given value, which may be null.
Parameters | |
---|---|
value |
Any!: the value of the attribute |
Public methods
getValue
open fun getValue(): Any!
Returns the value of the attribute, which may be null.
Return | |
---|---|
Any! |
the value of the attribute |
toString
open fun toString(): String
Returns the String representation of this Annotation.
Return | |
---|---|
String |
the String representation of this Annotation |