SpannableStringBuilder
open class SpannableStringBuilder : CharSequence, GetChars, Spannable, Editable, Appendable
kotlin.Any | |
↳ | android.text.SpannableStringBuilder |
This is the class for text whose content and markup can both be changed.
Summary
Public constructors | |
---|---|
Create a new SpannableStringBuilder with empty contents |
|
SpannableStringBuilder(text: CharSequence!) Create a new SpannableStringBuilder containing a copy of the specified text, including its spans if any. |
|
SpannableStringBuilder(text: CharSequence!, start: Int, end: Int) Create a new SpannableStringBuilder containing a copy of the specified slice of the specified text, including its spans if any. |
Public methods | |
---|---|
open SpannableStringBuilder |
append(text: CharSequence?) |
open SpannableStringBuilder! |
append(text: CharSequence!, what: Any!, flags: Int) Appends the character sequence |
open SpannableStringBuilder |
append(text: CharSequence?, start: Int, end: Int) |
open SpannableStringBuilder | |
open Unit |
clear() |
open Unit | |
open SpannableStringBuilder! | |
open Boolean |
Indicates whether some other object is "equal to" this one. |
open Char |
Return the char at the specified offset within the buffer. |
open Unit |
Copy the specified range of chars from this buffer into the specified array, beginning at the specified offset. |
open Array<InputFilter!>! | |
open Int |
getSpanEnd(what: Any!) Return the buffer offset of the end of the specified markup object, or -1 if it is not attached to this buffer. |
open Int |
getSpanFlags(what: Any!) Return the flags of the end of the specified markup object, or 0 if it is not attached to this buffer. |
open Int |
getSpanStart(what: Any!) Return the buffer offset of the beginning of the specified markup object, or -1 if it is not attached to this buffer. |
open Array<T>! |
Return an array of the spans of the specified type that overlap the specified range of the buffer. |
open Int |
getTextRunCursor(contextStart: Int, contextEnd: Int, dir: Int, offset: Int, cursorOpt: Int, p: Paint!) Returns the next cursor position in the run. |
open Int |
Returns the depth of TextWatcher callbacks. |
open Int |
hashCode() |
open SpannableStringBuilder! |
insert(where: Int, tb: CharSequence!, start: Int, end: Int) |
open SpannableStringBuilder! |
insert(where: Int, tb: CharSequence!) |
open Int |
nextSpanTransition(start: Int, limit: Int, kind: Class<Any!>!) Return the next offset after |
open Unit |
removeSpan(what: Any!) Remove the specified markup object from the buffer. |
open SpannableStringBuilder! |
replace(start: Int, end: Int, tb: CharSequence!) |
open SpannableStringBuilder! | |
open Unit |
setFilters(filters: Array<InputFilter!>!) |
open Unit |
Mark the specified range of text with the specified object. |
open CharSequence |
subSequence(startIndex: Int, endIndex: Int) Return a new CharSequence containing a copy of the specified range of this buffer, including the overlapping spans. |
open String |
toString() Return a String containing a copy of the chars in this buffer. |
open static SpannableStringBuilder! |
valueOf(source: CharSequence!) |
Properties | |
---|---|
open Int |
Return the number of chars in the buffer. |
Public constructors
SpannableStringBuilder
SpannableStringBuilder()
Create a new SpannableStringBuilder with empty contents
SpannableStringBuilder
SpannableStringBuilder(text: CharSequence!)
Create a new SpannableStringBuilder containing a copy of the specified text, including its spans if any.
SpannableStringBuilder
SpannableStringBuilder(
text: CharSequence!,
start: Int,
end: Int)
Create a new SpannableStringBuilder containing a copy of the specified slice of the specified text, including its spans if any.
Public methods
append
open fun append(text: CharSequence?): SpannableStringBuilder
Parameters | |
---|---|
csq |
The character sequence to append. If csq is null , then the four characters "null" are appended to this Appendable. |
Return | |
---|---|
SpannableStringBuilder |
A reference to this Appendable |
Exceptions | |
---|---|
java.io.IOException |
If an I/O error occurs |
append
open fun append(
text: CharSequence!,
what: Any!,
flags: Int
): SpannableStringBuilder!
Appends the character sequence text
and spans what
over the appended part. See Spanned
for an explanation of what the flags mean.
Parameters | |
---|---|
text |
CharSequence!: the character sequence to append. |
what |
Any!: the object to be spanned over the appended text. |
flags |
Int: see Spanned . |
Return | |
---|---|
SpannableStringBuilder! |
this SpannableStringBuilder . |
append
open fun append(
text: CharSequence?,
start: Int,
end: Int
): SpannableStringBuilder
Parameters | |
---|---|
csq |
The character sequence from which a subsequence will be appended. If csq is null , then characters will be appended as if csq contained the four characters "null" . |
start |
Int: The index of the first character in the subsequence |
end |
Int: The index of the character following the last character in the subsequence |
Return | |
---|---|
SpannableStringBuilder |
A reference to this Appendable |
Exceptions | |
---|---|
java.lang.IndexOutOfBoundsException |
If start or end are negative, start is greater than end , or end is greater than csq.length() |
java.io.IOException |
If an I/O error occurs |
append
open fun append(text: Char): SpannableStringBuilder
Parameters | |
---|---|
c |
The character to append |
Return | |
---|---|
SpannableStringBuilder |
A reference to this Appendable |
Exceptions | |
---|---|
java.io.IOException |
If an I/O error occurs |
equals
open fun equals(other: Any?): Boolean
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
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.
Parameters | |
---|---|
obj |
the reference object with which to compare. |
o |
This value may be null . |
Return | |
---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
get
open fun get(where: Int): Char
Return the char at the specified offset within the buffer.
Parameters | |
---|---|
index |
the index of the char value to be returned |
Return | |
---|---|
Char |
the specified char value |
Exceptions | |
---|---|
java.lang.IndexOutOfBoundsException |
if the index argument is negative or not less than length() |
getChars
open fun getChars(
start: Int,
end: Int,
dest: CharArray!,
destoff: Int
): Unit
Copy the specified range of chars from this buffer into the specified array, beginning at the specified offset.
getSpanEnd
open fun getSpanEnd(what: Any!): Int
Return the buffer offset of the end of the specified markup object, or -1 if it is not attached to this buffer.
getSpanFlags
open fun getSpanFlags(what: Any!): Int
Return the flags of the end of the specified markup object, or 0 if it is not attached to this buffer.
getSpanStart
open fun getSpanStart(what: Any!): Int
Return the buffer offset of the beginning of the specified markup object, or -1 if it is not attached to this buffer.
getSpans
open fun <T : Any!> getSpans(
queryStart: Int,
queryEnd: Int,
kind: Class<T>?
): Array<T>!
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.
Parameters | |
---|---|
kind |
Class<T>?: This value may be null . |
getTextRunCursor
open fungetTextRunCursor(
contextStart: Int,
contextEnd: Int,
dir: Int,
offset: Int,
cursorOpt: Int,
p: Paint!
): Int
Deprecated: 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.
Parameters | |
---|---|
contextStart |
Int: the start index of the context |
contextEnd |
Int: the (non-inclusive) end index of the context |
dir |
Int: 1 if the run is RTL, otherwise 0 |
offset |
Int: the cursor position to move from |
cursorOpt |
Int: how to move the cursor, one of CURSOR_AFTER, CURSOR_AT_OR_AFTER, CURSOR_BEFORE, CURSOR_AT_OR_BEFORE, or CURSOR_AT |
p |
Paint!: the Paint object that is requesting this information |
Return | |
---|---|
Int |
the offset of the next position, or -1 |
getTextWatcherDepth
open fun getTextWatcherDepth(): Int
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
open fun hashCode(): Int
Return | |
---|---|
Int |
a hash code value for this object. |
insert
open fun insert(
where: Int,
tb: CharSequence!,
start: Int,
end: Int
): SpannableStringBuilder!
insert
open fun insert(
where: Int,
tb: CharSequence!
): SpannableStringBuilder!
nextSpanTransition
open fun nextSpanTransition(
start: Int,
limit: Int,
kind: Class<Any!>!
): Int
Return the next offset after start
but less than or equal to limit
where a span of the specified type begins or ends.
removeSpan
open fun removeSpan(what: Any!): Unit
Remove the specified markup object from the buffer.
replace
open fun replace(
start: Int,
end: Int,
tb: CharSequence!
): SpannableStringBuilder!
replace
open fun replace(
start: Int,
end: Int,
tb: CharSequence!,
tbstart: Int,
tbend: Int
): SpannableStringBuilder!
Return | |
---|---|
SpannableStringBuilder! |
a reference to this object. |
setSpan
open fun setSpan(
what: Any!,
start: Int,
end: Int,
flags: Int
): Unit
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
open fun subSequence(
startIndex: Int,
endIndex: Int
): CharSequence
Return a new CharSequence containing a copy of the specified range of this buffer, including the overlapping spans.
Parameters | |
---|---|
start |
the start index, inclusive |
end |
the end index, exclusive |
Return | |
---|---|
CharSequence |
the specified subsequence |
Exceptions | |
---|---|
java.lang.IndexOutOfBoundsException |
if start or end are negative, if end is greater than length() , or if start is greater than end |
toString
open fun toString(): String
Return a String containing a copy of the chars in this buffer.
Return | |
---|---|
String |
a string consisting of exactly this sequence of characters |
valueOf
open static fun valueOf(source: CharSequence!): SpannableStringBuilder!
Properties
length
open val length: Int
Return the number of chars in the buffer.
Return | |
---|---|
Int |
the number of char s in this sequence |