Build 1.0_r1(from source)

android.text
Interface Spanned

All Superinterfaces:
CharSequence
All Known Subinterfaces:
Editable, Spannable
All Known Implementing Classes:
Layout.SpannedEllipsizer, SpannableString, SpannableStringBuilder, SpannedString

public interface Spanned
extends CharSequence

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.


Field Summary
static int SPAN_EXCLUSIVE_EXCLUSIVE
          Spans of type SPAN_EXCLUSIVE_EXCLUSIVE do not expand to include text inserted at either their starting or ending point.
static int SPAN_EXCLUSIVE_INCLUSIVE
          Non-0-length spans of type SPAN_INCLUSIVE_EXCLUSIVE expand to include text inserted at their ending point but not at their starting point.
static 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.
static int SPAN_INCLUSIVE_INCLUSIVE
          Spans of type SPAN_INCLUSIVE_INCLUSIVE expand to include text inserted at either their starting or ending point.
static 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.
static int SPAN_MARK_POINT
          SPAN_MARK_POINT is a synonym for SPAN_INCLUSIVE_INCLUSIVE.
static 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).
static int SPAN_POINT_MARK
          SPAN_POINT_MARK is a synonym for SPAN_EXCLUSIVE_EXCLUSIVE.
static 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.
static int SPAN_PRIORITY
          The bits specified by the SPAN_PRIORITY bitmap determine the order of change notifications -- higher numbers go first.
static int SPAN_PRIORITY_SHIFT
          The bits numbered just above SPAN_PRIORITY_SHIFT determine the order of change notifications -- higher numbers go first.
static 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.
static 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.
 
Method Summary
 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.
 int getSpanFlags(Object tag)
          Return the flags that were specified when Spannable.setSpan(java.lang.Object, int, int, int) was used to attach the specified markup object, or 0 if the specified object has not been attached.
<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.
 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.
 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.
 
Methods inherited from interface java.lang.CharSequence
charAt, length, subSequence, toString
 

Field Detail

SPAN_MARK_MARK

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.

See Also:
Constant Field Values

SPAN_MARK_POINT

static final int SPAN_MARK_POINT
SPAN_MARK_POINT is a synonym for SPAN_INCLUSIVE_INCLUSIVE.

See Also:
Constant Field Values

SPAN_POINT_MARK

static final int SPAN_POINT_MARK
SPAN_POINT_MARK is a synonym for SPAN_EXCLUSIVE_EXCLUSIVE.

See Also:
Constant Field Values

SPAN_POINT_POINT

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.

See Also:
Constant Field Values

SPAN_PARAGRAPH

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

See Also:
Constant Field Values

SPAN_INCLUSIVE_EXCLUSIVE

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.

See Also:
Constant Field Values

SPAN_INCLUSIVE_INCLUSIVE

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

See Also:
Constant Field Values

SPAN_EXCLUSIVE_EXCLUSIVE

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.

See Also:
Constant Field Values

SPAN_EXCLUSIVE_INCLUSIVE

static final int SPAN_EXCLUSIVE_INCLUSIVE
Non-0-length spans of type SPAN_INCLUSIVE_EXCLUSIVE expand to include text inserted at their ending point but not at their starting point. When 0-length, they behave like points.

See Also:
Constant Field Values

SPAN_USER_SHIFT

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.

See Also:
Constant Field Values

SPAN_USER

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.

See Also:
Constant Field Values

SPAN_PRIORITY_SHIFT

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.

See Also:
Constant Field Values

SPAN_PRIORITY

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.

See Also:
Constant Field Values
Method Detail

getSpans

<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. Specify Object.class for the type if you want all the objects regardless of type.


getSpanStart

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.


getSpanEnd

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.


getSpanFlags

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


nextSpanTransition

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.


Build 1.0_r1(from source)

Please submit a feedback, bug or feature