diff options
author | Robert Ly <robertly@google.com> | 2014-05-08 15:02:11 -0700 |
---|---|---|
committer | Robert Ly <robertly@google.com> | 2014-05-09 17:01:21 -0700 |
commit | 37cb8d75303a8f795ce66670761ca2263327563d (patch) | |
tree | ae7f2bec08d7a4f3685ad74386e89af6afa7f596 /docs | |
parent | 7fadcf84244172004568c4107083d415f1285b75 (diff) | |
download | frameworks_base-37cb8d75303a8f795ce66670761ca2263327563d.zip frameworks_base-37cb8d75303a8f795ce66670761ca2263327563d.tar.gz frameworks_base-37cb8d75303a8f795ce66670761ca2263327563d.tar.bz2 |
docs: fix some notification code for wear stacks
Change-Id: Iea6b444480b161ab08a9ba02dbabb22773862cf0
Diffstat (limited to 'docs')
-rw-r--r-- | docs/html/guide/topics/resources/string-resource.jd | 107 | ||||
-rw-r--r-- | docs/html/wear/images/notif_summary_framed.png | bin | 0 -> 39277 bytes | |||
-rw-r--r-- | docs/html/wear/notifications/stacks.jd | 90 |
3 files changed, 178 insertions, 19 deletions
diff --git a/docs/html/guide/topics/resources/string-resource.jd b/docs/html/guide/topics/resources/string-resource.jd index 5a96ba1..e2326ec 100644 --- a/docs/html/guide/topics/resources/string-resource.jd +++ b/docs/html/guide/topics/resources/string-resource.jd @@ -20,9 +20,6 @@ your application with strings:</p> information about styling and formatting strings, see the section about <a href="#FormattingAndStyling">Formatting and Styling</a>.</p> - - - <h2 id="String">String</h2> <p>A single string that can be referenced from the application or from other resource files (such @@ -433,7 +430,7 @@ java.lang.Object...)">format</a>(res.getString(R.string.welcome_messages), usern -<h3>Styling with HTML markup</h3> +<h3 id="StylingWithHTML">Styling with HTML markup</h3> <p>You can add styling to your strings with HTML markup. For example:</p> <pre> @@ -497,5 +494,107 @@ java.lang.Object...)">format</a>(res.getString(R.string.welcome_messages), escap CharSequence styledText = Html.fromHtml(text); </pre> +<h2 id="StylingWithSpannables">Styling with Spannables</h2> +<p> +A {@link android.text.Spannable} is a text object that you can style with +typeface properties such as color and font weight. You use +{@link android.text.SpannableStringBuilder} to build +your text and then apply styles defined in the {@link android.text.style} +package to the text. +</p> + +<p>You can use the following helper methods to set up much of the work +of creating spannable text:</p> + +<pre style="pretty-print"> +/** + * Returns a CharSequence that concatenates the specified array of CharSequence + * objects and then applies a list of zero or more tags to the entire range. + * + * @param content an array of character sequences to apply a style to + * @param tags the styled span objects to apply to the content + * such as android.text.style.StyleSpan + * + */ +private static CharSequence apply(CharSequence[] content, Object... tags) { + SpannableStringBuilder text = new SpannableStringBuilder(); + openTags(text, tags); + for (CharSequence item : content) { + text.append(item); + } + closeTags(text, tags); + return text; +} + +/** + * Iterates over an array of tags and applies them to the beginning of the specified + * Spannable object so that future text appended to the text will have the styling + * applied to it. Do not call this method directly. + */ +private static void openTags(Spannable text, Object[] tags) { + for (Object tag : tags) { + text.setSpan(tag, 0, 0, Spannable.SPAN_MARK_MARK); + } +} + +/** + * "Closes" the specified tags on a Spannable by updating the spans to be + * endpoint-exclusive so that future text appended to the end will not take + * on the same styling. Do not call this method directly. + */ +private static void closeTags(Spannable text, Object[] tags) { + int len = text.length(); + for (Object tag : tags) { + if (len > 0) { + text.setSpan(tag, 0, len, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE); + } else { + text.removeSpan(tag); + } + } +} +</pre> +<p> +The following <code>bold</code>, <code>italic</code>, and <code>color</code> +methods show you how to call the helper methods to apply +styles defined in the {@link android.text.style} package. You +can create similar methods to do other types of text styling. +</p> + +<pre style="pretty-print"> +/** + * Returns a CharSequence that applies boldface to the concatenation + * of the specified CharSequence objects. + */ +public static CharSequence bold(CharSequence... content) { + return apply(content, new StyleSpan(Typeface.BOLD)); +} + +/** + * Returns a CharSequence that applies italics to the concatenation + * of the specified CharSequence objects. + */ +public static CharSequence italic(CharSequence... content) { + return apply(content, new StyleSpan(Typeface.ITALIC)); +} + +/** + * Returns a CharSequence that applies a foreground color to the + * concatenation of the specified CharSequence objects. + */ +public static CharSequence color(int color, CharSequence... content) { + return apply(content, new ForegroundColorSpan(color)); +} +</pre> +<p> +Here's an example of how to chain these methods to create a character sequence +with different types of styling applied to individual words: +</p> + +<pre style="pretty-print"> +// Create an italic "hello, " a red "world", +// and bold the entire sequence. +CharSequence text = bold(italic(res.getString(R.string.hello)), + color(Color.RED, res.getString(R.string.world))); +</pre>
\ No newline at end of file diff --git a/docs/html/wear/images/notif_summary_framed.png b/docs/html/wear/images/notif_summary_framed.png Binary files differnew file mode 100644 index 0000000..17b1703 --- /dev/null +++ b/docs/html/wear/images/notif_summary_framed.png diff --git a/docs/html/wear/notifications/stacks.jd b/docs/html/wear/notifications/stacks.jd index 7f955f6..a2d34ce 100644 --- a/docs/html/wear/notifications/stacks.jd +++ b/docs/html/wear/notifications/stacks.jd @@ -2,8 +2,8 @@ page.title=Stacking Notifications @jd:body -<img src="{@docRoot}wear/images/11_bundles_B.png" height="200" width="169" style="float:right;margin:0 0 20px 40px" /> -<img src="{@docRoot}wear/images/11_bundles_A.png" height="200" width="169" style="float:right;margin:0 0 20px 40px" /> +<img src="{@docRoot}wear/images/11_bundles_B.png" height="200" width="169" style="float:right;margin:0 0 20px 40px" alt="" /> +<img src="{@docRoot}wear/images/11_bundles_A.png" height="200" width="169" style="float:right;margin:0 0 20px 40px" alt="" /> <p>When creating notifications for a handheld device, you should always aggregate similar notifications into a single summary notification. For example, if your app creates notifications @@ -29,20 +29,44 @@ Wear</a>.</p> <p>To create a stack, call <a href="{@docRoot}reference/android/preview/support/wearable/notifications/WearableNotifications.Builder.html#setGroup(java.lang.String, int)"> -<code>setGroup()</code></a> for each notification you want in the stack, passing the same -group key. For example:</p> +<code>setGroup()</code></a> for each notification you want in the stack and specify a +group key. Then call <a href="{@docRoot}reference/android/preview/support/v4/app/NotificationManagerCompat.html#notify(int, android.app.Notification)"><code>notify()</code></a> to send it to the wearable.</p> <pre style="clear:right"> final static String GROUP_KEY_EMAILS = "group_key_emails"; +// Build the notification and pass this builder to WearableNotifications.Builder NotificationCompat.Builder builder = new NotificationCompat.Builder(mContext) - .setContentTitle("New mail from " + sender) - .setContentText(subject) + .setContentTitle("New mail from " + sender1) + .setContentText(subject1) .setSmallIcon(R.drawable.new_mail); -Notification notif = new WearableNotifications.Builder(builder) +Notification notif1 = new WearableNotifications.Builder(builder) .setGroup(GROUP_KEY_EMAILS) .build(); + +// Issue the notification +NotificationManagerCompat notificationManager = + NotificationManagerCompat.from(this); +notificationManager.notify(notificationId1, notif); +</pre> + +<p>Later on, when you create another notification, specify +the same group key. When you call <a href="{@docRoot}reference/android/preview/support/v4/app/NotificationManagerCompat.html#notify(int, android.app.Notification)"><code>notify()</code></a>, this notification appears +in the same stack as the previous notification, instead of as a new card:</p> + +<pre style="clear:right"> +builder = new NotificationCompat.Builder(mContext) + .setContentTitle("New mail from " + sender2) + .setContentText(subject2) + .setSmallIcon(R.drawable.new_mail); + +// Use the same group as the previous notification +Notification notif2 = new WearableNotifications.Builder(builder) + .setGroup(GROUP_KEY_EMAILS) + .build(); + +notificationManager.notify(notificationId2, notif); </pre> <p>By default, notifications appear in the order in which you added them, with the most recent @@ -54,19 +78,55 @@ href="{@docRoot}reference/android/preview/support/wearable/notifications/Wearabl <h2 id="AddSummary">Add a Summary Notification</h2> +<img src="{@docRoot}wear/images/notif_summary_framed.png" height="242" width="330" style="float:right;margin:0 0 20px 40px" alt="" /> + <p>It's important that you still provide a summary notification that appears on handheld devices. So in addition to adding each unique notification to the same stack group, also add a summary notification, but set its order position to be <a href="{@docRoot}reference/android/preview/support/wearable/notifications/WearableNotifications.html#GROUP_ORDER_SUMMARY"><code>GROUP_ORDER_SUMMARY</code></a>.</p> -<pre> -Notification summaryNotification = new WearableNotifications.Builder(builder) - .setGroup(GROUP_KEY_EMAILS, WearableNotifications.GROUP_ORDER_SUMMARY) - .build(); -</pre> +<p>This notification does not appear in your stack of notifications on the wearable, but +appears as the only notification on the handheld device.</p> -<p>This notification will not appear in your stack of notifications on the wearable, but -appears as the only notification on the handheld device. +<pre style="clear:right"> +Bitmap largeIcon = BitmapFactory.decodeResource(getResources(), + R.drawable.ic_large_icon); + +builder = new NotificationCompat.Builder(this) + .setSmallIcon(R.drawable.ic_small_icon) + .setLargeIcon(largeIcon); + +// Use the same group key and pass this builder to InboxStyle notification +WearableNotifications.Builder wearableBuilder = new WearableNotifications + .Builder(builder) + .setGroup(GROUP_KEY_EMAILS, + WearableNotifications.GROUP_ORDER_SUMMARY); + +// Build the final notification to show on the handset +Notification summaryNotification = new NotificationCompat.InboxStyle( + wearableBuilder.getCompatBuilder()) + .addLine("Alex Faaborg Check this out") + .addLine("Jeff Chang Launch Party") + .setBigContentTitle("2 new messages") + .setSummaryText("johndoe@gmail.com") + .build(); + +notificationManager.notify(notificationId3, summaryNotification); +</pre> +<p> +This notification uses {@link android.support.v4.app.NotificationCompat.InboxStyle}, +which gives you an easy way to create notifications for email or messaging apps. +You can use this style, another one defined in {@link android.support.v4.app.NotificationCompat}, +or no style for the summary notification. +</p> + +<p class="note"><b>Tip:</b> +To style the text like in the example screenshot, see +<a href="{@docRoot}guide/topics/resources/string-resource.html#StylingWithHTML">Styling +with HTML markup</a> and +<a href="{@docRoot}guide/topics/resources/string-resource.html#StylingWithSpannables">Styling +with Spannables</a>. +</p> </body> -</html> +</html>
\ No newline at end of file |