SpannableStringBuilder

SpannableStringBuilder

public SpannableStringBuilder ()

Create a new SpannableStringBuilder with empty contents

SpannableStringBuilder

public SpannableStringBuilder (CharSequence text)

Create a new SpannableStringBuilder containing a copy of the specified text, including its spans if any.

SpannableStringBuilder

public SpannableStringBuilder (CharSequence text, 
                int start, 
                int end)

Create a new SpannableStringBuilder containing a copy of the specified slice of the specified text, including its spans if any.

append

public SpannableStringBuilder append (char text)

Convenience for append(String.valueOf(text)).

append

public SpannableStringBuilder append (CharSequence text, 
                Object what, 
                int flags)

Appends the character sequence text and spans what over the appended part. See Spanned for an explanation of what the flags mean.

append

public SpannableStringBuilder append (CharSequence text, 
                int start, 
                int end)

Convenience for replace(length(), length(), text, start, end)

append

public SpannableStringBuilder append (CharSequence text)

Convenience for replace(length(), length(), text, 0, text.length())

charAt

public char charAt (int where)

Return the char at the specified offset within the buffer.

clear

public void clear ()

Convenience for replace(0, length(), "", 0, 0). Note that this clears the text, not the spans; use clearSpans() if you need that.

clearSpans

public void clearSpans ()

Removes all spans from the Editable, as if by calling Spannable.removeSpan(Object) on each of them.

delete

public SpannableStringBuilder delete (int start, 
                int end)

Convenience for replace(st, en, "", 0, 0)

equals

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

getChars

public void getChars (int start, 
                int end, 
                char[] dest, 
                int destoff)

Copy the specified range of chars from this buffer into the specified array, beginning at the specified offset.

getFilters

public InputFilter[] getFilters ()

Returns the array of input filters that are currently applied to changes to this Editable.

getSpanEnd

public int getSpanEnd (Object what)

Return the buffer offset of the end of the specified markup object, or -1 if it is not attached to this buffer.

getSpanFlags

public int getSpanFlags (Object what)

Return the flags of the end of the specified markup object, or 0 if it is not attached to this buffer.

getSpanStart

public int getSpanStart (Object what)

Return the buffer offset of the beginning of the specified markup object, or -1 if it is not attached to this buffer.

getSpans

public T[] getSpans (int queryStart, 
                int queryEnd, 
                Class<T> kind)

Return an array of the spans of the specified type that overlap the specified range of the buffer. The kind may be Object.class to get a list of all the spans regardless of type.

getTextRunCursor

public int getTextRunCursor (int contextStart, 
                int contextEnd, 
                int dir, 
                int offset, 
                int cursorOpt, 
                Paint p)

This method was deprecated in API level 15.
This is an internal method, refrain from using it in your code

Returns the next cursor position in the run. This avoids placing the cursor between surrogates, between characters that form conjuncts, between base characters and combining marks, or within a reordering cluster.

The context is the shaping context for cursor movement, generally the bounds of the metric span enclosing the cursor in the direction of movement. contextStart, contextEnd and offset are relative to the start of the string.

If cursorOpt is CURSOR_AT and the offset is not a valid cursor position, this returns -1. Otherwise this will never return a value before contextStart or after contextEnd.

getTextWatcherDepth

public int getTextWatcherDepth ()

Returns the depth of TextWatcher callbacks. Returns 0 when the object is not handling TextWatchers. A return value greater than 1 implies that a TextWatcher caused a change that recursively triggered a TextWatcher.

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

insert

public SpannableStringBuilder insert (int where, 
                CharSequence tb)

Convenience for replace(where, where, text, 0, text.length());

insert

public SpannableStringBuilder insert (int where, 
                CharSequence tb, 
                int start, 
                int end)

Convenience for replace(where, where, text, start, end)

length

public int length ()

Return the number of chars in the buffer.

nextSpanTransition

public int nextSpanTransition (int start, 
                int limit, 
                Class<T> kind)

Return the next offset after start but less than or equal to limit where a span of the specified type begins or ends.

removeSpan

public void removeSpan (Object what)

Remove the specified markup object from the buffer.

replace

public SpannableStringBuilder replace (int start, 
                int end, 
                CharSequence tb, 
                int tbstart, 
                int tbend)

Replaces the specified range (st…en) of text in this Editable with a copy of the slice start…end from source. The destination slice may be empty, in which case the operation is an insertion, or the source slice may be empty, in which case the operation is a deletion.

Before the change is committed, each filter that was set with setFilters(InputFilter) is given the opportunity to modify the source text.

If source is Spanned, the spans from it are preserved into the Editable. Existing spans within the Editable that entirely cover the replaced range are retained, but any that were strictly within the range that was replaced are removed. If the source contains a span with Spanned.SPAN_PARAGRAPH flag, and it does not satisfy the paragraph boundary constraint, it is not retained. As a special case, the cursor position is preserved even when the entire range where it is located is replaced.

replace

public SpannableStringBuilder replace (int start, 
                int end, 
                CharSequence tb)

Convenience for replace(st, en, text, 0, text.length())

setFilters

public void setFilters (InputFilter[] filters)

Sets the series of filters that will be called in succession whenever the text of this Editable is changed, each of which has the opportunity to limit or transform the text that is being inserted.

setSpan

public void setSpan (Object what, 
                int start, 
                int end, 
                int flags)

Mark the specified range of text with the specified object. The flags determine how the span will behave when text is inserted at the start or end of the span's range.

subSequence

public CharSequence subSequence (int start, 
                int end)

Return a new CharSequence containing a copy of the specified range of this buffer, including the overlapping spans.

toString

public String toString ()

Return a String containing a copy of the chars in this buffer.

valueOf

public static SpannableStringBuilder valueOf (CharSequence source)