Spanned.java revision b7332c714caf2ef07a827eb691e134d16003965f
19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2006 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.text; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This is the interface for text that has markup objects attached to 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * ranges of it. Not all text classes have mutable markup or text; 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * see {@link Spannable} for mutable markup and {@link Editable} for 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * mutable text. 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic interface Spanned 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectextends CharSequence 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project{ 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Bitmask of bits that are relevent for controlling point/mark behavior 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * of spans. 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int SPAN_POINT_MARK_MASK = 0x33; 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 0-length spans with type SPAN_MARK_MARK behave like text marks: 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * they remain at their original offset when text is inserted 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * at that offset. 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int SPAN_MARK_MARK = 0x11; 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * SPAN_MARK_POINT is a synonym for {@link #SPAN_INCLUSIVE_INCLUSIVE}. 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int SPAN_MARK_POINT = 0x12; 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * SPAN_POINT_MARK is a synonym for {@link #SPAN_EXCLUSIVE_EXCLUSIVE}. 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int SPAN_POINT_MARK = 0x21; 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 0-length spans with type SPAN_POINT_POINT behave like cursors: 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * they are pushed forward by the length of the insertion when text 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * is inserted at their offset. 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int SPAN_POINT_POINT = 0x22; 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * SPAN_PARAGRAPH behaves like SPAN_INCLUSIVE_EXCLUSIVE 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * (SPAN_MARK_MARK), except that if either end of the span is 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * at the end of the buffer, that end behaves like _POINT 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * instead (so SPAN_INCLUSIVE_INCLUSIVE if it starts in the 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * middle and ends at the end, or SPAN_EXCLUSIVE_INCLUSIVE 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * if it both starts and ends at the end). 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Its endpoints must be the start or end of the buffer or 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * immediately after a \n character, and if the \n 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * that anchors it is deleted, the endpoint is pulled to the 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * next \n that follows in the buffer (or to the end of 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the buffer). 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int SPAN_PARAGRAPH = 0x33; 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Non-0-length spans of type SPAN_INCLUSIVE_EXCLUSIVE expand 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to include text inserted at their starting point but not at their 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * ending point. When 0-length, they behave like marks. 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int SPAN_INCLUSIVE_EXCLUSIVE = SPAN_MARK_MARK; 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Spans of type SPAN_INCLUSIVE_INCLUSIVE expand 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to include text inserted at either their starting or ending point. 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int SPAN_INCLUSIVE_INCLUSIVE = SPAN_MARK_POINT; 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Spans of type SPAN_EXCLUSIVE_EXCLUSIVE do not expand 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to include text inserted at either their starting or ending point. 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * They can never have a length of 0 and are automatically removed 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * from the buffer if all the text they cover is removed. 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int SPAN_EXCLUSIVE_EXCLUSIVE = SPAN_POINT_MARK; 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 94b7332c714caf2ef07a827eb691e134d16003965fSeth Pensack-Rinehart * Non-0-length spans of type SPAN_EXCLUSIVE_INCLUSIVE expand 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to include text inserted at their ending point but not at their 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * starting point. When 0-length, they behave like points. 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int SPAN_EXCLUSIVE_INCLUSIVE = SPAN_POINT_POINT; 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This flag is set on spans that are being used to apply temporary 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * styling information on the composing text of an input method, so that 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * they can be found and removed when the composing text is being 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * replaced. 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int SPAN_COMPOSING = 0x100; 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This flag will be set for intermediate span changes, meaning there 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * is guaranteed to be another change following it. Typically it is 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * used for {@link Selection} which automatically uses this with the first 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * offset it sets when updating the selection. 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int SPAN_INTERMEDIATE = 0x200; 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The bits numbered SPAN_USER_SHIFT and above are available 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * for callers to use to store scalar data associated with their 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * span object. 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int SPAN_USER_SHIFT = 24; 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The bits specified by the SPAN_USER bitfield are available 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * for callers to use to store scalar data associated with their 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * span object. 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int SPAN_USER = 0xFFFFFFFF << SPAN_USER_SHIFT; 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The bits numbered just above SPAN_PRIORITY_SHIFT determine the order 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * of change notifications -- higher numbers go first. You probably 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * don't need to set this; it is used so that when text changes, the 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * text layout gets the chance to update itself before any other 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * callbacks can inquire about the layout of the text. 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int SPAN_PRIORITY_SHIFT = 16; 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The bits specified by the SPAN_PRIORITY bitmap determine the order 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * of change notifications -- higher numbers go first. You probably 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * don't need to set this; it is used so that when text changes, the 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * text layout gets the chance to update itself before any other 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * callbacks can inquire about the layout of the text. 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int SPAN_PRIORITY = 0xFF << SPAN_PRIORITY_SHIFT; 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return an array of the markup objects attached to the specified 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * slice of this CharSequence and whose type is the specified type 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * or a subclass of it. Specify Object.class for the type if you 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * want all the objects regardless of type. 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public <T> T[] getSpans(int start, int end, Class<T> type); 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the beginning of the range of text to which the specified 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * markup object is attached, or -1 if the object is not attached. 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int getSpanStart(Object tag); 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the end of the range of text to which the specified 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * markup object is attached, or -1 if the object is not attached. 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int getSpanEnd(Object tag); 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the flags that were specified when {@link Spannable#setSpan} was 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * used to attach the specified markup object, or 0 if the specified 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * object has not been attached. 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int getSpanFlags(Object tag); 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the first offset greater than or equal to <code>start</code> 1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * where a markup object of class <code>type</code> begins or ends, 1769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * or <code>limit</code> if there are no starts or ends greater than or 1779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * equal to <code>start</code> but less than <code>limit</code>. Specify 1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <code>null</code> or Object.class for the type if you want every 1799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * transition regardless of type. 1809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int nextSpanTransition(int start, int limit, Class type); 1829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 183