summaryrefslogtreecommitdiffstats
path: root/core/java/android
diff options
context:
space:
mode:
authorScott Main <smain@google.com>2009-11-11 10:45:04 -0800
committerScott Main <smain@google.com>2009-11-11 14:31:17 -0800
commitdbc7e27ef10349f11ac940d59ff4f812319fce51 (patch)
tree1243167ea1bcd102a4df27e7494279c6a3affccb /core/java/android
parent88427cff609e668185010af2244500be5823595e (diff)
downloadframeworks_base-dbc7e27ef10349f11ac940d59ff4f812319fce51.zip
frameworks_base-dbc7e27ef10349f11ac940d59ff4f812319fce51.tar.gz
frameworks_base-dbc7e27ef10349f11ac940d59ff4f812319fce51.tar.bz2
docs: document the 'showSearchIconAsBadge" flag and
"icon" attribute as deprecated. bug 2105329
Diffstat (limited to 'core/java/android')
-rw-r--r--core/java/android/app/SearchManager.java27
1 files changed, 11 insertions, 16 deletions
diff --git a/core/java/android/app/SearchManager.java b/core/java/android/app/SearchManager.java
index 7f5a1e7..2e94a2f 100644
--- a/core/java/android/app/SearchManager.java
+++ b/core/java/android/app/SearchManager.java
@@ -769,17 +769,15 @@ import java.util.List;
* </tr>
*
* <tr><th>android:icon</th>
- * <td>If provided, this icon will be shown in place of the label above the search box.
- * This is a reference to a drawable (icon) resource. Note that the application icon
- * is also used as an icon to the left of the search box and you cannot modify this
- * behavior, so including the icon attribute is unecessary and this may be
- * deprecated in the future.</td>
+ * <td><strong>This is deprecated.</strong><br/>The default
+ * application icon is now always used, so this attribute is
+ * obsolete.</td>
* <td align="center">No</td>
* </tr>
*
* <tr><th>android:hint</th>
- * <td>This is the text to display in the search text field when no user text has been
- * entered.</td>
+ * <td>This is the text to display in the search text field when no text
+ * has been entered by the user.</td>
* <td align="center">No</td>
* </tr>
*
@@ -790,17 +788,14 @@ import java.util.List;
* <tbody>
* <tr><th>showSearchLabelAsBadge</th>
* <td>If set, this flag enables the display of the search target (label)
- * above the search box. If this flag and showSearchIconAsBadge
- * (see below) are both not set, no badge will be shown.</td>
+ * above the search box. As an alternative, you may
+ * want to instead use "hint" text in the search box.
+ * See the "android:hint" attribute above.</td>
* </tr>
* <tr><th>showSearchIconAsBadge</th>
- * <td>If set, this flag enables the display of the search target (icon)
- * above the search box. If this flag and showSearchLabelAsBadge
- * (see above) are both not set, no badge will be shown. If both flags
- * are set, showSearchIconAsBadge has precedence and the icon will be
- * shown. Because the application icon is now used to the left of the
- * search box by default, using this search mode is no longer necessary
- * and may be deprecated in the future.</td>
+ * <td><strong>This is deprecated.</strong><br/>The default
+ * application icon is now always used, so this
+ * option is obsolete.</td>
* </tr>
* <tr><th>queryRewriteFromData</th>
* <td>If set, this flag causes the suggestion column SUGGEST_COLUMN_INTENT_DATA