WatchFaceStyle
public
class
WatchFaceStyle
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.support.wearable.watchface.WatchFaceStyle |
This class is deprecated.
Use Watch Face Format APIs instead.
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 WatchFaceService.Engine.setWatchFaceStyle(WatchFaceStyle) in the onCreate method of your WatchFaceService.Engine.onCreate(SurfaceHolder) override.
To construct a WatchFaceStyle use WatchFaceStyle.Builder.
Summary
Nested classes | |
|---|---|
class |
WatchFaceStyle.Builder
This class is deprecated. Use Watch Face Format APIs instead. |
Constants | |
|---|---|
int |
AMBIENT_PEEK_MODE_HIDDEN
This constant is deprecated. Wear 2.0 doesn't have peeking cards |
int |
AMBIENT_PEEK_MODE_VISIBLE
This constant is deprecated. Wear 2.0 doesn't have peeking cards |
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
This constant is deprecated. Wear 2.0 doesn't have peeking cards |
int |
PEEK_MODE_VARIABLE
This constant is deprecated. Wear 2.0 doesn't have peeking cards |
int |
PEEK_OPACITY_MODE_OPAQUE
This constant is deprecated. Wear 2.0 doesn't have peeking cards |
int |
PEEK_OPACITY_MODE_TRANSLUCENT
This constant is deprecated. Wear 2.0 doesn't have peeking cards |
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 |
|---|
Fields | |
|---|---|
public
static
final
Creator<WatchFaceStyle> |
CREATOR
|
Public methods | |
|---|---|
int
|
describeContents()
|
boolean
|
equals(Object otherObj)
|
int
|
getAccentColor()
Returns the accent color which can be set by developers to customise watch face. |
boolean
|
getAcceptsTapEvents()
Whether the watchface accepts tap events. |
int
|
getAmbientPeekMode()
This method is deprecated. Wear 2.0 doesn't have peeking cards |
int
|
getBackgroundVisibility()
This method is deprecated. Wear 2.0 doesn't have peeking cards |
int
|
getCardPeekMode()
This method is deprecated. Wear 2.0 doesn't have peeking cards |
ComponentName
|
getComponent()
The component of the watch face activity whose style is being specified. |
boolean
|
getHideNotificationIndicator()
Whether to hide the dot indicator that is displayed at the bottom of the watch face if there are any unread notifications. |
int
|
getHotwordIndicatorGravity()
This method is deprecated. Wear 2.0 doesn't show hotword indication on the watch face |
int
|
getPeekOpacityMode()
This method is deprecated. Wear 2.0 doesn't have peeking cards |
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 | |
|---|---|
Constants
AMBIENT_PEEK_MODE_HIDDEN
public static final int AMBIENT_PEEK_MODE_HIDDEN
This constant is deprecated.
Wear 2.0 doesn't have peeking cards
When this ambient mode is selected, the peek card will be hidden in ambient.
Constant Value: 1 (0x00000001)
AMBIENT_PEEK_MODE_VISIBLE
public static final int AMBIENT_PEEK_MODE_VISIBLE
This constant is deprecated.
Wear 2.0 doesn't have peeking cards
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
public static final 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
public static final 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
public static final int PEEK_MODE_SHORT
This constant is deprecated.
Wear 2.0 doesn't have peeking cards
When this peek mode is selected, peek cards will be a single line tall.
Constant Value: 1 (0x00000001)
PEEK_MODE_VARIABLE
public static final int PEEK_MODE_VARIABLE
This constant is deprecated.
Wear 2.0 doesn't have peeking cards
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
public static final int PEEK_OPACITY_MODE_OPAQUE
This constant is deprecated.
Wear 2.0 doesn't have peeking cards
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
public static final int PEEK_OPACITY_MODE_TRANSLUCENT
This constant is deprecated.
Wear 2.0 doesn't have peeking cards
When this peek opacity is selected, the first card will be slightly translucent when peeking.
Constant Value: 1 (0x00000001)
PROTECT_HOTWORD_INDICATOR
public static final 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
public static final 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
public static final 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
public int describeContents ()
| Returns | |
|---|---|
int |
|
getAccentColor
public int getAccentColor ()
Returns the accent color which can be set by developers to customise watch face. It will be used when drawing the unread notification indicator.
| Returns | |
|---|---|
int |
|
getAcceptsTapEvents
public boolean getAcceptsTapEvents ()
Whether the watchface accepts tap events. The default is false.
| Returns | |
|---|---|
boolean |
|
getAmbientPeekMode
public int getAmbientPeekMode ()
This method is deprecated.
Wear 2.0 doesn't have peeking cards
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
public int getBackgroundVisibility ()
This method is deprecated.
Wear 2.0 doesn't have peeking cards
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
public int getCardPeekMode ()
This method is deprecated.
Wear 2.0 doesn't have peeking cards
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
public ComponentName getComponent ()
The component of the watch face activity whose style is being specified.
| Returns | |
|---|---|
ComponentName |
|
getHideNotificationIndicator
public boolean getHideNotificationIndicator ()
Whether to hide the dot indicator that is displayed at the bottom of the watch face if there
are any unread notifications. The default value is false, but note that the dot will not be
displayed if the numerical unread count indicator is being shown (i.e. if getShowUnreadCountIndicator() is true).
| Returns | |
|---|---|
boolean |
|
getHotwordIndicatorGravity
public int getHotwordIndicatorGravity ()
This method is deprecated.
Wear 2.0 doesn't show hotword indication on the watch face
Controls position of hotword (OK Google) on the screen. Can be set to any combination of
horizontal Gravity constant (Gravity.LEFT, Gravity.CENTER_HORIZONTAL, Gravity.RIGHT) and vertical
Gravity constants (Gravity.TOP, Gravity.CENTER_VERTICAL, Gravity.BOTTOM), e.g. Gravity.LEFT
| Gravity.BOTTOM. On circular screens, only the vertical gravity is respected.
| Returns | |
|---|---|
int |
|
getPeekOpacityMode
public int getPeekOpacityMode ()
This method is deprecated.
Wear 2.0 doesn't have peeking cards
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
public 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
public 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
public 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 (Gravity.LEFT, Gravity.CENTER_HORIZONTAL, Gravity.RIGHT) and vertical Gravity constants (Gravity.TOP, Gravity.CENTER_VERTICAL, Gravity.BOTTOM), e.g. Gravity.LEFT | Gravity.BOTTOM. On circular screens,
only the vertical gravity is respected.
| Returns | |
|---|---|
int |
|
getViewProtectionMode
public 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
public int hashCode ()
| Returns | |
|---|---|
int |
|
writeToParcel
public void writeToParcel (Parcel parcel, int flags)
| Parameters | |
|---|---|
parcel |
Parcel |
flags |
int |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-07-10 UTC.