WatchFaceStyle
public
class
WatchFaceStyle
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.support.wearable.watchface.WatchFaceStyle |
A style descriptor for watch faces.
Parameters here affect how the system UI will be drawn over a watch face. An instance of this
class should be passed in to setWatchFaceStyle(WatchFaceStyle) in the onCreate method of your onCreate(SurfaceHolder) override.
To construct a WatchFaceStyle use WatchFaceStyle.Builder.
Summary
Nested classes | |
|---|---|
class |
WatchFaceStyle.Builder
Builder for WatchFaceStyle objects. |
Constants | |
|---|---|
int |
AMBIENT_PEEK_MODE_HIDDEN
When this ambient mode is selected, the peek card will be hidden in ambient. |
int |
AMBIENT_PEEK_MODE_VISIBLE
When this ambient mode is selected, the peek card will be shown in ambient. |
int |
BACKGROUND_VISIBILITY_INTERRUPTIVE
When this background visibility is selected, the background of the peek card should only be shown briefly, and only if the peek card represents an interruptive notification. |
int |
BACKGROUND_VISIBILITY_PERSISTENT
When this background visibility is selected, the background of the peek card should always be shown. |
int |
PEEK_MODE_SHORT
When this peek mode is selected, peek cards will be a single line tall. |
int |
PEEK_MODE_VARIABLE
When this peek mode is selected, peek cards will be as tall as needed, while maintaining enough space at the top to draw the system time and status icons. |
int |
PEEK_OPACITY_MODE_OPAQUE
When this peek opacity is selected, the first card will be completely opaque when peeking. |
int |
PEEK_OPACITY_MODE_TRANSLUCENT
When this peek opacity is selected, the first card will be slightly translucent when peeking. |
int |
PROTECT_HOTWORD_INDICATOR
Whether to put a semi-transparent black background behind the "Ok Google" string to make it visible on a white background. |
int |
PROTECT_STATUS_BAR
Whether to put a semi-transparent black background behind the status bar to make it visible on white backgrounds. |
int |
PROTECT_WHOLE_SCREEN
Whether to dim the entire watch face background slightly so the time and icons are always visible. |
Inherited constants |
|---|
 From
interface
android.os.Parcelable
|
Fields | |
|---|---|
public
static
final
Creator<WatchFaceStyle> |
CREATOR
|
Public methods | |
|---|---|
int
|
describeContents()
|
boolean
|
equals(Object otherObj)
|
boolean
|
getAcceptsTapEvents()
Whether the watchface accepts tap events. |
int
|
getAmbientPeekMode()
Controls how the first, peeking card will be displayed while the watch is in ambient, black & white mode. |
int
|
getBackgroundVisibility()
Controls displaying background of the first, peeking card. |
int
|
getCardPeekMode()
Controls how far into the screen the first card will peek while the watch face is displayed. |
ComponentName
|
getComponent()
The component of the watch face activity whose style is being specified. |
int
|
getHotwordIndicatorGravity()
Controls position of hotword (OK Google) on the screen. |
int
|
getPeekOpacityMode()
Controls whether the first, peeking card should be opaque when the watch face is displayed. |
boolean
|
getShowSystemUiTime()
If true, the system will draw the system-style time over the watch face. |
boolean
|
getShowUnreadCountIndicator()
Whether to add an indicator of how many unread cards there are in the stream. |
int
|
getStatusBarGravity()
Controls position of status icons (battery state, lack of connection) on the screen. |
int
|
getViewProtectionMode()
Allows adding background color to UI elements of the home screen, so they are readable on the watch face. |
int
|
hashCode()
|
String
|
toString()
|
void
|
writeToParcel(Parcel parcel, int flags)
|
Inherited methods | |
|---|---|
From
class
java.lang.Object
| |
From
interface
android.os.Parcelable
| |
Constants
AMBIENT_PEEK_MODE_HIDDEN
int AMBIENT_PEEK_MODE_HIDDEN
When this ambient mode is selected, the peek card will be hidden in ambient.
Constant Value: 1 (0x00000001)
AMBIENT_PEEK_MODE_VISIBLE
int AMBIENT_PEEK_MODE_VISIBLE
When this ambient mode is selected, the peek card will be shown in ambient. This is the default mode.
Constant Value: 0 (0x00000000)
BACKGROUND_VISIBILITY_INTERRUPTIVE
int BACKGROUND_VISIBILITY_INTERRUPTIVE
When this background visibility is selected, the background of the peek card should only be shown briefly, and only if the peek card represents an interruptive notification. This is the default mode.
Constant Value: 0 (0x00000000)
BACKGROUND_VISIBILITY_PERSISTENT
int BACKGROUND_VISIBILITY_PERSISTENT
When this background visibility is selected, the background of the peek card should always be shown. Note that this will obscure your watch face whenever there is a peek card showing.
Constant Value: 1 (0x00000001)
PEEK_MODE_SHORT
int PEEK_MODE_SHORT
When this peek mode is selected, peek cards will be a single line tall.
Constant Value: 1 (0x00000001)
PEEK_MODE_VARIABLE
int PEEK_MODE_VARIABLE
When this peek mode is selected, peek cards will be as tall as needed, while maintaining enough space at the top to draw the system time and status icons. This is the default mode.
Constant Value: 0 (0x00000000)
PEEK_OPACITY_MODE_OPAQUE
int PEEK_OPACITY_MODE_OPAQUE
When this peek opacity is selected, the first card will be completely opaque when peeking. This is the default mode.
Constant Value: 0 (0x00000000)
PEEK_OPACITY_MODE_TRANSLUCENT
int PEEK_OPACITY_MODE_TRANSLUCENT
When this peek opacity is selected, the first card will be slightly translucent when peeking.
Constant Value: 1 (0x00000001)
PROTECT_HOTWORD_INDICATOR
int PROTECT_HOTWORD_INDICATOR
Whether to put a semi-transparent black background behind the "Ok Google" string to make it visible on a white background.
Constant Value: 2 (0x00000002)
PROTECT_STATUS_BAR
int PROTECT_STATUS_BAR
Whether to put a semi-transparent black background behind the status bar to make it visible on white backgrounds.
Constant Value: 1 (0x00000001)
PROTECT_WHOLE_SCREEN
int PROTECT_WHOLE_SCREEN
Whether to dim the entire watch face background slightly so the time and icons are always visible.
Constant Value: 4 (0x00000004)
Fields
Public methods
describeContents
int describeContents ()
| Returns | |
|---|---|
int |
|
equals
boolean equals (Object otherObj)
| Parameters | |
|---|---|
otherObj |
Object
|
| Returns | |
|---|---|
boolean |
|
getAcceptsTapEvents
boolean getAcceptsTapEvents ()
Whether the watchface accepts tap events. The default is false.
| Returns | |
|---|---|
boolean |
|
getAmbientPeekMode
int getAmbientPeekMode ()
Controls how the first, peeking card will be displayed while the watch is in ambient,
black & white mode. Can be set to AMBIENT_PEEK_MODE_VISIBLE or
AMBIENT_PEEK_MODE_HIDDEN. AMBIENT_PEEK_MODE_VISIBLE is the default value.
| Returns | |
|---|---|
int |
|
getBackgroundVisibility
int getBackgroundVisibility ()
Controls displaying background of the first, peeking card. Can be set to either
BACKGROUND_VISIBILITY_INTERRUPTIVE or BACKGROUND_VISIBILITY_PERSISTENT.
BACKGROUND_VISIBILITY_INTERRUPTIVE is the default value.
| Returns | |
|---|---|
int |
|
getCardPeekMode
int getCardPeekMode ()
Controls how far into the screen the first card will peek while the watch face is displayed.
Can be set to either PEEK_MODE_VARIABLE or PEEK_MODE_SHORT.
PEEK_MODE_VARIABLE is the default value.
| Returns | |
|---|---|
int |
|
getComponent
ComponentName getComponent ()
The component of the watch face activity whose style is being specified.
| Returns | |
|---|---|
ComponentName |
|
getHotwordIndicatorGravity
int getHotwordIndicatorGravity ()
Controls position of hotword (OK Google) on the screen. Can be set to any combination of
horizontal Gravity constant (LEFT, CENTER_HORIZONTAL,
RIGHT) and vertical Gravity constants (TOP,
CENTER_VERTICAL, BOTTOM), e.g. Gravity.LEFT | Gravity.BOTTOM.
On circular screens, only the vertical gravity is respected.
| Returns | |
|---|---|
int |
|
getPeekOpacityMode
int getPeekOpacityMode ()
Controls whether the first, peeking card should be opaque when the watch face is displayed.
Can be set to either PEEK_OPACITY_MODE_OPAQUE or
PEEK_OPACITY_MODE_TRANSLUCENT. PEEK_OPACITY_MODE_OPAQUE is the default
value.
| Returns | |
|---|---|
int |
|
getShowSystemUiTime
boolean getShowSystemUiTime ()
If true, the system will draw the system-style time over the watch face. By default it is set to false, which means you should draw or clearly represent the time on your watch face.
| Returns | |
|---|---|
boolean |
|
getShowUnreadCountIndicator
boolean getShowUnreadCountIndicator ()
Whether to add an indicator of how many unread cards there are in the stream. The indicator will be displayed next to status icons (battery state, lack of connection). The default value is false.
| Returns | |
|---|---|
boolean |
|
getStatusBarGravity
int getStatusBarGravity ()
Controls position of status icons (battery state, lack of connection) on the screen. Can be
set to any combination of horizontal Gravity constant (LEFT,
CENTER_HORIZONTAL, RIGHT) and vertical Gravity
constants (TOP, CENTER_VERTICAL, BOTTOM),
e.g. Gravity.LEFT | Gravity.BOTTOM. On circular screens, only the vertical gravity is
respected.
| Returns | |
|---|---|
int |
|
getViewProtectionMode
int getViewProtectionMode ()
Allows adding background color to UI elements of the home screen, so they are readable on
the watch face. This should be used if the watch face color is close to being white. This
can be set to any combination of PROTECT_STATUS_BAR,
PROTECT_HOTWORD_INDICATOR and PROTECT_WHOLE_SCREEN, e.g.
PROTECT_STATUS_BAR | PROTECT_HOTWORD_INDICATOR. The default value is no protection.
| Returns | |
|---|---|
int |
|
hashCode
int hashCode ()
| Returns | |
|---|---|
int |
|
toString
String toString ()
| Returns | |
|---|---|
String |
|
writeToParcel
void writeToParcel (Parcel parcel,
int flags)
| Parameters | |
|---|---|
parcel |
Parcel
|
flags |
int
|