Spanned
interface Spanned : CharSequence
| android.text.Spanned |
This is the interface for text that has markup objects attached to ranges of it. Not all text classes have mutable markup or text; see Spannable for mutable markup and Editable for mutable text.
Summary
| Constants | |
|---|---|
| static Int |
This flag is set on spans that are being used to apply temporary styling information on the composing text of an input method, so that they can be found and removed when the composing text is being replaced. |
| static Int |
Spans of type SPAN_EXCLUSIVE_EXCLUSIVE do not expand to include text inserted at either their starting or ending point. |
| static Int |
Non-0-length spans of type SPAN_EXCLUSIVE_INCLUSIVE expand to include text inserted at their ending point but not at their starting point. |
| static Int |
Non-0-length spans of type SPAN_INCLUSIVE_EXCLUSIVE expand to include text inserted at their starting point but not at their ending point. |
| static Int |
Spans of type SPAN_INCLUSIVE_INCLUSIVE expand to include text inserted at either their starting or ending point. |
| static Int |
This flag will be set for intermediate span changes, meaning there is guaranteed to be another change following it. |
| static Int |
0-length spans with type SPAN_MARK_MARK behave like text marks: they remain at their original offset when text is inserted at that offset. |
| static Int |
SPAN_MARK_POINT is a synonym for |
| static Int |
SPAN_PARAGRAPH behaves like SPAN_INCLUSIVE_EXCLUSIVE (SPAN_MARK_MARK), except that if either end of the span is at the end of the buffer, that end behaves like _POINT instead (so SPAN_INCLUSIVE_INCLUSIVE if it starts in the middle and ends at the end, or SPAN_EXCLUSIVE_INCLUSIVE if it both starts and ends at the end). |
| static Int |
SPAN_POINT_MARK is a synonym for |
| static Int |
Bitmask of bits that are relevent for controlling point/mark behavior of spans. |
| static Int |
0-length spans with type SPAN_POINT_POINT behave like cursors: they are pushed forward by the length of the insertion when text is inserted at their offset. |
| static Int |
The bits specified by the SPAN_PRIORITY bitmap determine the order of change notifications -- higher numbers go first. |
| static Int |
The bits numbered just above SPAN_PRIORITY_SHIFT determine the order of change notifications -- higher numbers go first. |
| static Int |
The bits specified by the SPAN_USER bitfield are available for callers to use to store scalar data associated with their span object. |
| static Int |
The bits numbered SPAN_USER_SHIFT and above are available for callers to use to store scalar data associated with their span object. |
| Public methods | |
|---|---|
| abstract Int |
getSpanEnd(tag: Any!)Return the end of the range of text to which the specified markup object is attached, or -1 if the object is not attached. |
| abstract Int |
getSpanFlags(tag: Any!)Return the flags that were specified when |
| abstract Int |
getSpanStart(tag: Any!)Return the beginning of the range of text to which the specified markup object is attached, or -1 if the object is not attached. |
| abstract Array<T>! |
Return an array of the markup objects attached to the specified slice of this CharSequence and whose type is the specified type or a subclass of it. |
| abstract Int |
nextSpanTransition(start: Int, limit: Int, type: Class<Any!>!)Return the first offset greater than |
Constants
SPAN_COMPOSING
static val SPAN_COMPOSING: Int
This flag is set on spans that are being used to apply temporary styling information on the composing text of an input method, so that they can be found and removed when the composing text is being replaced.
Value: 256
SPAN_EXCLUSIVE_EXCLUSIVE
static val SPAN_EXCLUSIVE_EXCLUSIVE: Int
Spans of type SPAN_EXCLUSIVE_EXCLUSIVE do not expand to include text inserted at either their starting or ending point. They can never have a length of 0 and are automatically removed from the buffer if all the text they cover is removed.
Value: 33
SPAN_EXCLUSIVE_INCLUSIVE
static val SPAN_EXCLUSIVE_INCLUSIVE: Int
Non-0-length spans of type SPAN_EXCLUSIVE_INCLUSIVE expand to include text inserted at their ending point but not at their starting point. When 0-length, they behave like points.
Value: 34
SPAN_INCLUSIVE_EXCLUSIVE
static val SPAN_INCLUSIVE_EXCLUSIVE: Int
Non-0-length spans of type SPAN_INCLUSIVE_EXCLUSIVE expand to include text inserted at their starting point but not at their ending point. When 0-length, they behave like marks.
Value: 17
SPAN_INCLUSIVE_INCLUSIVE
static val SPAN_INCLUSIVE_INCLUSIVE: Int
Spans of type SPAN_INCLUSIVE_INCLUSIVE expand to include text inserted at either their starting or ending point.
Value: 18
SPAN_INTERMEDIATE
static val SPAN_INTERMEDIATE: Int
This flag will be set for intermediate span changes, meaning there is guaranteed to be another change following it. Typically it is used for Selection which automatically uses this with the first offset it sets when updating the selection.
Value: 512
SPAN_MARK_MARK
static val SPAN_MARK_MARK: Int
0-length spans with type SPAN_MARK_MARK behave like text marks: they remain at their original offset when text is inserted at that offset. Conceptually, the text is added after the mark.
Value: 17
SPAN_MARK_POINT
static val SPAN_MARK_POINT: Int
SPAN_MARK_POINT is a synonym for SPAN_INCLUSIVE_INCLUSIVE.
Value: 18
SPAN_PARAGRAPH
static val SPAN_PARAGRAPH: Int
SPAN_PARAGRAPH behaves like SPAN_INCLUSIVE_EXCLUSIVE (SPAN_MARK_MARK), except that if either end of the span is at the end of the buffer, that end behaves like _POINT instead (so SPAN_INCLUSIVE_INCLUSIVE if it starts in the middle and ends at the end, or SPAN_EXCLUSIVE_INCLUSIVE if it both starts and ends at the end).
Its endpoints must be the start or end of the buffer or immediately after a \n character, and if the \n that anchors it is deleted, the endpoint is pulled to the next \n that follows in the buffer (or to the end of the buffer). If a span with SPAN_PARAGRAPH flag is pasted into another text and the paragraph boundary constraint is not satisfied, the span is discarded.
Value: 51
SPAN_POINT_MARK
static val SPAN_POINT_MARK: Int
SPAN_POINT_MARK is a synonym for SPAN_EXCLUSIVE_EXCLUSIVE.
Value: 33
SPAN_POINT_MARK_MASK
static val SPAN_POINT_MARK_MASK: Int
Bitmask of bits that are relevent for controlling point/mark behavior of spans. MARK and POINT are conceptually located between two adjacent characters. A MARK is "attached" to the character before, while a POINT will stick to the character after. The insertion cursor is conceptually located between the MARK and the POINT. As a result, inserting a new character between a MARK and a POINT will leave the MARK unchanged, while the POINT will be shifted, now located after the inserted character and still glued to the same character after it. Depending on whether the insertion happens at the beginning or the end of a span, the span will hence be expanded to include the new character (when the span is using a MARK at its beginning or a POINT at its end) or it will be excluded. Note that before and after here refer to offsets in the String, which are independent from the visual representation of the text (left-to-right or right-to-left).
Value: 51
SPAN_POINT_POINT
static val SPAN_POINT_POINT: Int
0-length spans with type SPAN_POINT_POINT behave like cursors: they are pushed forward by the length of the insertion when text is inserted at their offset. The text is conceptually inserted before the point.
Value: 34
SPAN_PRIORITY
static val SPAN_PRIORITY: Int
The bits specified by the SPAN_PRIORITY bitmap determine the order of change notifications -- higher numbers go first. You probably don't need to set this; it is used so that when text changes, the text layout gets the chance to update itself before any other callbacks can inquire about the layout of the text.
Value: 16711680
SPAN_PRIORITY_SHIFT
static val SPAN_PRIORITY_SHIFT: Int
The bits numbered just above SPAN_PRIORITY_SHIFT determine the order of change notifications -- higher numbers go first. You probably don't need to set this; it is used so that when text changes, the text layout gets the chance to update itself before any other callbacks can inquire about the layout of the text.
Value: 16
SPAN_USER
static val SPAN_USER: Int
The bits specified by the SPAN_USER bitfield are available for callers to use to store scalar data associated with their span object.
Value: -16777216
SPAN_USER_SHIFT
static val SPAN_USER_SHIFT: Int
The bits numbered SPAN_USER_SHIFT and above are available for callers to use to store scalar data associated with their span object.
Value: 24
Public methods
getSpanEnd
abstract fun getSpanEnd(tag: Any!): Int
Return the end of the range of text to which the specified markup object is attached, or -1 if the object is not attached.
getSpanFlags
abstract fun getSpanFlags(tag: Any!): Int
Return the flags that were specified when Spannable#setSpan was used to attach the specified markup object, or 0 if the specified object has not been attached.
getSpanStart
abstract fun getSpanStart(tag: Any!): Int
Return the beginning of the range of text to which the specified markup object is attached, or -1 if the object is not attached.
getSpans
abstract fun <T : Any!> getSpans(
start: Int,
end: Int,
type: Class<T>!
): Array<T>!
Return an array of the markup objects attached to the specified slice of this CharSequence and whose type is the specified type or a subclass of it. Specify Object.class for the type if you want all the objects regardless of type.
nextSpanTransition
abstract fun nextSpanTransition(
start: Int,
limit: Int,
type: Class<Any!>!
): Int
Return the first offset greater than start where a markup object of class type begins or ends, or limit if there are no starts or ends greater than start but less than limit. Specify null or Object.class for the type if you want every transition regardless of type.