Spanned

public interface Spanned implements CharSequence

Known Indirect Subclasses Editable, Spannable, SpannableString, SpannableStringBuilder, SpannedString Editable This is the interface for text whose content and markup can be changed (as opposed to immutable text like Strings).  Spannable This is the interface for text to which markup objects can be attached and detached.  SpannableString This is the class for text whose content is immutable but to which markup objects can be attached and detached.  SpannableStringBuilder This is the class for text whose content and markup can both be changed.  SpannedString This is the class for text whose content and markup are immutable.

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.

Constant Summary

int	SPAN_COMPOSING	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.
int	SPAN_EXCLUSIVE_EXCLUSIVE	Spans of type SPAN_EXCLUSIVE_EXCLUSIVE do not expand to include text inserted at either their starting or ending point.
int	SPAN_EXCLUSIVE_INCLUSIVE	Non-0-length spans of type SPAN_EXCLUSIVE_INCLUSIVE expand to include text inserted at their ending point but not at their starting point.
int	SPAN_INCLUSIVE_EXCLUSIVE	Non-0-length spans of type SPAN_INCLUSIVE_EXCLUSIVE expand to include text inserted at their starting point but not at their ending point.
int	SPAN_INCLUSIVE_INCLUSIVE	Spans of type SPAN_INCLUSIVE_INCLUSIVE expand to include text inserted at either their starting or ending point.
int	SPAN_INTERMEDIATE	This flag will be set for intermediate span changes, meaning there is guaranteed to be another change following it.
int	SPAN_MARK_MARK	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.
int	SPAN_MARK_POINT	SPAN_MARK_POINT is a synonym for SPAN_INCLUSIVE_INCLUSIVE.
int	SPAN_PARAGRAPH	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).
int	SPAN_POINT_MARK	SPAN_POINT_MARK is a synonym for SPAN_EXCLUSIVE_EXCLUSIVE.
int	SPAN_POINT_MARK_MASK	Bitmask of bits that are relevent for controlling point/mark behavior of spans.
int	SPAN_POINT_POINT	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.
int	SPAN_PRIORITY	The bits specified by the SPAN_PRIORITY bitmap determine the order of change notifications -- higher numbers go first.
int	SPAN_PRIORITY_SHIFT	The bits numbered just above SPAN_PRIORITY_SHIFT determine the order of change notifications -- higher numbers go first.
int	SPAN_USER	The bits specified by the SPAN_USER bitfield are available for callers to use to store scalar data associated with their span object.
int	SPAN_USER_SHIFT	The bits numbered SPAN_USER_SHIFT and above are available for callers to use to store scalar data associated with their span object.

Public Method Summary

abstract int	getSpanEnd(Object tag) 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(Object tag) Return the flags that were specified when Spannable.setSpan(Object, int, int, int) was used to attach the specified markup object, or 0 if the specified object has not been attached.
abstract int	getSpanStart(Object tag) 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 <T> T[]	getSpans(int start, int end, Class<T> type) 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(int start, int limit, Class type) Return the first offset greater than or equal to start where a markup object of class type begins or ends, or limit if there are no starts or ends greater than or equal to start but less than limit.

Inherited Method Summary

From interface java.lang.CharSequence

abstract char	charAt(int arg0)
IntStream	chars()
IntStream	codePoints()
abstract int	length()
abstract CharSequence	subSequence(int arg0, int arg1)
abstract String	toString()

Constants

public static final int SPAN_COMPOSING

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.

Constant Value: 256

public static final int SPAN_EXCLUSIVE_EXCLUSIVE

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.

Constant Value: 33

public static final int SPAN_EXCLUSIVE_INCLUSIVE

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.

Constant Value: 34

public static final int SPAN_INCLUSIVE_EXCLUSIVE

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.

Constant Value: 17

public static final int SPAN_INCLUSIVE_INCLUSIVE

Spans of type SPAN_INCLUSIVE_INCLUSIVE expand to include text inserted at either their starting or ending point.

Constant Value: 18

public static final int SPAN_INTERMEDIATE

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.

Constant Value: 512

public static final int SPAN_MARK_MARK

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.

Constant Value: 17

public static final int SPAN_MARK_POINT

SPAN_MARK_POINT is a synonym for SPAN_INCLUSIVE_INCLUSIVE.

Constant Value: 18

public static final int SPAN_PARAGRAPH

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).

Constant Value: 51

public static final int SPAN_POINT_MARK

SPAN_POINT_MARK is a synonym for SPAN_EXCLUSIVE_EXCLUSIVE.

Constant Value: 33

public static final int SPAN_POINT_MARK_MASK

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).

Constant Value: 51

public static final int SPAN_POINT_POINT

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.

Constant Value: 34

public static final int SPAN_PRIORITY

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.

Constant Value: 16711680

public static final int SPAN_PRIORITY_SHIFT

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.

Constant Value: 16

public static final int SPAN_USER

The bits specified by the SPAN_USER bitfield are available for callers to use to store scalar data associated with their span object.

Constant Value: -16777216

public static final int SPAN_USER_SHIFT

The bits numbered SPAN_USER_SHIFT and above are available for callers to use to store scalar data associated with their span object.

Constant Value: 24

Public Methods

public abstract int getSpanEnd (Object tag)

Return the end of the range of text to which the specified markup object is attached, or -1 if the object is not attached.

Parameters

tag

public abstract int getSpanFlags (Object tag)

Return the flags that were specified when Spannable.setSpan(Object, int, int, int) was used to attach the specified markup object, or 0 if the specified object has not been attached.

Parameters

tag

public abstract int getSpanStart (Object tag)

Return the beginning of the range of text to which the specified markup object is attached, or -1 if the object is not attached.

Parameters

tag

public abstract T[] getSpans (int start, int end, Class<T> type)

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.

Parameters

start
end
type

public abstract int nextSpanTransition (int start, int limit, Class type)

Return the first offset greater than or equal to start where a markup object of class type begins or ends, or limit if there are no starts or ends greater than or equal to start but less than limit. Specify null or Object.class for the type if you want every transition regardless of type.

Parameters

start
limit
type