# WatchFaceStyle Summary: [Nested Classes](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle#nestedclasses) \| [Constants](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle#constants) \| [Inherited Constants](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle#inhconstants) \| [Fields](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle#lfields) \| [Methods](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle#inhmethods) # WatchFaceStyle ` public class WatchFaceStyle ` ` extends `[Object](http://developer.android.com/reference/java/lang/Object.html)` ` ` implements `[Parcelable](http://developer.android.com/reference/android/os/Parcelable.html)` ` |---|---------------------------------------------------| | [java.lang.Object](http://developer.android.com/reference/java/lang/Object.html) || | ↳ | android.support.wearable.watchface.WatchFaceStyle |
*** ** * ** *** **This class is deprecated.** Use [Watch Face Format](https://developer.android.com/training/wearables/wff) 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)](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceService.Engine.html#setWatchFaceStyle(android.support.wearable.watchface.WatchFaceStyle)) in the `onCreate` method of your [WatchFaceService.Engine.onCreate(SurfaceHolder)](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceService.Engine.html#onCreate(android.view.SurfaceHolder)) override. To construct a WatchFaceStyle use [WatchFaceStyle.Builder](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.Builder.html). ## Summary | ### Nested classes || |----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` class` | [WatchFaceStyle.Builder](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.Builder.html) *This class is deprecated. Use [Watch Face Format](https://developer.android.com/training/wearables/wff) APIs instead.* | | ### Constants || |-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [AMBIENT_PEEK_MODE_HIDDEN](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#AMBIENT_PEEK_MODE_HIDDEN) *This constant is deprecated. Wear 2.0 doesn't have peeking cards* | | `int` | [AMBIENT_PEEK_MODE_VISIBLE](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#AMBIENT_PEEK_MODE_VISIBLE) *This constant is deprecated. Wear 2.0 doesn't have peeking cards* | | `int` | [BACKGROUND_VISIBILITY_INTERRUPTIVE](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#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](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#BACKGROUND_VISIBILITY_PERSISTENT) When this background visibility is selected, the background of the peek card should always be shown. | | `int` | [PEEK_MODE_SHORT](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#PEEK_MODE_SHORT) *This constant is deprecated. Wear 2.0 doesn't have peeking cards* | | `int` | [PEEK_MODE_VARIABLE](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#PEEK_MODE_VARIABLE) *This constant is deprecated. Wear 2.0 doesn't have peeking cards* | | `int` | [PEEK_OPACITY_MODE_OPAQUE](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#PEEK_OPACITY_MODE_OPAQUE) *This constant is deprecated. Wear 2.0 doesn't have peeking cards* | | `int` | [PEEK_OPACITY_MODE_TRANSLUCENT](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#PEEK_OPACITY_MODE_TRANSLUCENT) *This constant is deprecated. Wear 2.0 doesn't have peeking cards* | | `int` | [PROTECT_HOTWORD_INDICATOR](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#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](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#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](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#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` |-------|---------------------------------| | `int` | `CONTENTS_FILE_DESCRIPTOR` | | `int` | `PARCELABLE_WRITE_RETURN_VALUE` | | | ### Fields || |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------| | ` public static final `[Creator](http://developer.android.com/reference/android/os/Parcelable.Creator.html)`<`[WatchFaceStyle](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html)`>` | [CREATOR](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#CREATOR) | | ### Public methods || |-----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` int` | ` `[describeContents](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#describeContents())`() ` | | ` boolean` | ` `[equals](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#equals(java.lang.Object))`(`[Object](http://developer.android.com/reference/java/lang/Object.html)` otherObj) ` | | ` int` | ` `[getAccentColor](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#getAccentColor())`() ` Returns the accent color which can be set by developers to customise watch face. | | ` boolean` | ` `[getAcceptsTapEvents](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#getAcceptsTapEvents())`() ` Whether the watchface accepts tap events. | | ` int` | ` `[getAmbientPeekMode](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#getAmbientPeekMode())`() ` *This method is deprecated. Wear 2.0 doesn't have peeking cards* | | ` int` | ` `[getBackgroundVisibility](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#getBackgroundVisibility())`() ` *This method is deprecated. Wear 2.0 doesn't have peeking cards* | | ` int` | ` `[getCardPeekMode](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#getCardPeekMode())`() ` *This method is deprecated. Wear 2.0 doesn't have peeking cards* | | ` `[ComponentName](http://developer.android.com/reference/android/content/ComponentName.html) | ` `[getComponent](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#getComponent())`() ` The component of the watch face activity whose style is being specified. | | ` boolean` | ` `[getHideNotificationIndicator](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#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](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#getHotwordIndicatorGravity())`() ` *This method is deprecated. Wear 2.0 doesn't show hotword indication on the watch face* | | ` int` | ` `[getPeekOpacityMode](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#getPeekOpacityMode())`() ` *This method is deprecated. Wear 2.0 doesn't have peeking cards* | | ` boolean` | ` `[getShowSystemUiTime](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#getShowSystemUiTime())`() ` If true, the system will draw the system-style time over the watch face. | | ` boolean` | ` `[getShowUnreadCountIndicator](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#getShowUnreadCountIndicator())`() ` Whether to add an indicator of how many unread cards there are in the stream. | | ` int` | ` `[getStatusBarGravity](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#getStatusBarGravity())`() ` Controls position of status icons (battery state, lack of connection) on the screen. | | ` int` | ` `[getViewProtectionMode](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#getViewProtectionMode())`() ` Allows adding background color to UI elements of the home screen, so they are readable on the watch face. | | ` int` | ` `[hashCode](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#hashCode())`() ` | | ` `[String](http://developer.android.com/reference/java/lang/String.html) | ` `[toString](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#toString())`() ` | | ` void` | ` `[writeToParcel](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](http://developer.android.com/reference/android/os/Parcel.html)` parcel, int flags) ` | | ### Inherited methods | |-----------------------|---| | From class ` `[java.lang.Object](http://developer.android.com/reference/java/lang/Object.html)` ` |------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| | ` `[Object](http://developer.android.com/reference/java/lang/Object.html) | ` clone() ` | | ` boolean` | ` equals(`[Object](http://developer.android.com/reference/java/lang/Object.html)` arg0) ` | | ` void` | ` finalize() ` | | ` final `[Class](http://developer.android.com/reference/java/lang/Class.html)`` | ` getClass() ` | | ` int` | ` hashCode() ` | | ` final void` | ` notify() ` | | ` final void` | ` notifyAll() ` | | ` `[String](http://developer.android.com/reference/java/lang/String.html) | ` toString() ` | | ` final void` | ` wait(long arg0, int arg1) ` | | ` final void` | ` wait(long arg0) ` | | ` final void` | ` wait() ` | || | From interface ` `[android.os.Parcelable](http://developer.android.com/reference/android/os/Parcelable.html)` ` |------------------|-------------------------------------------------------------------------------------------------------------| | ` abstract int` | ` describeContents() ` | | ` abstract void` | ` writeToParcel(`[Parcel](http://developer.android.com/reference/android/os/Parcel.html)` arg0, int arg1) ` | || ## 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 ### CREATOR ``` public static final Creator CREATOR ```

## Public methods ### describeContents ``` public int describeContents () ```

| Returns || |-------|--------| | `int` |
| ### equals ``` public boolean equals (Object otherObj) ```

| Parameters || |------------|-----------------| | `otherObj` | `Object`
| | Returns || |-----------|--------| | `boolean` |
| ### 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](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#AMBIENT_PEEK_MODE_VISIBLE) or [AMBIENT_PEEK_MODE_HIDDEN](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#AMBIENT_PEEK_MODE_HIDDEN). [AMBIENT_PEEK_MODE_VISIBLE](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#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](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#BACKGROUND_VISIBILITY_INTERRUPTIVE) or [BACKGROUND_VISIBILITY_PERSISTENT](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#BACKGROUND_VISIBILITY_PERSISTENT). [BACKGROUND_VISIBILITY_INTERRUPTIVE](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#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](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#PEEK_MODE_VARIABLE) or [PEEK_MODE_SHORT](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#PEEK_MODE_SHORT). [PEEK_MODE_VARIABLE](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#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](http://developer.android.com/reference/android/content/ComponentName.html) |
| ### 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()](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#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](http://developer.android.com/reference/android/view/Gravity.html#LEFT), [Gravity.CENTER_HORIZONTAL](http://developer.android.com/reference/android/view/Gravity.html#CENTER_HORIZONTAL), [Gravity.RIGHT](http://developer.android.com/reference/android/view/Gravity.html#RIGHT)) and vertical Gravity constants ([Gravity.TOP](http://developer.android.com/reference/android/view/Gravity.html#TOP), [Gravity.CENTER_VERTICAL](http://developer.android.com/reference/android/view/Gravity.html#CENTER_VERTICAL), [Gravity.BOTTOM](http://developer.android.com/reference/android/view/Gravity.html#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](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#PEEK_OPACITY_MODE_OPAQUE) or [PEEK_OPACITY_MODE_TRANSLUCENT](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#PEEK_OPACITY_MODE_TRANSLUCENT). [PEEK_OPACITY_MODE_OPAQUE](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#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](http://developer.android.com/reference/android/view/Gravity.html) constant ([Gravity.LEFT](http://developer.android.com/reference/android/view/Gravity.html#LEFT), [Gravity.CENTER_HORIZONTAL](http://developer.android.com/reference/android/view/Gravity.html#CENTER_HORIZONTAL), [Gravity.RIGHT](http://developer.android.com/reference/android/view/Gravity.html#RIGHT)) and vertical [Gravity](http://developer.android.com/reference/android/view/Gravity.html) constants ([Gravity.TOP](http://developer.android.com/reference/android/view/Gravity.html#TOP), [Gravity.CENTER_VERTICAL](http://developer.android.com/reference/android/view/Gravity.html#CENTER_VERTICAL), [Gravity.BOTTOM](http://developer.android.com/reference/android/view/Gravity.html#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](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#PROTECT_STATUS_BAR), [PROTECT_HOTWORD_INDICATOR](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#PROTECT_HOTWORD_INDICATOR) and [PROTECT_WHOLE_SCREEN](https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#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` |
| ### toString ``` public String toString () ```

| Returns || |------------------------------------------------------------------------|--------| | [String](http://developer.android.com/reference/java/lang/String.html) |
| ### writeToParcel ``` public void writeToParcel (Parcel parcel, int flags) ```

| Parameters || |----------|-----------------| | `parcel` | `Parcel`
| | `flags` | `int`
|