Button

Artifact: androidx.wear.tiles:tiles-material

View Source

Added in 1.1.0

Deprecated in 1.2.0

---

Kotlin |Java

class Button : LayoutElementBuilders.LayoutElement

---

This class is deprecated.

Use the new class androidx.wear.protolayout.material.Button which provides the same API and functionality.

Tiles component Button that represents clickable button with the given content.

The Button is circular in shape. The recommended sizes are defined in ButtonDefaults.

The recommended set of ButtonColors styles can be obtained from ButtonDefaults., e.g. PRIMARY_COLORS to get a color scheme for a primary Button.

When accessing the contents of a container for testing, note that this element can't be simply casted back to the original type, i.e.:

Button button = new Button...
Box box = new Box.Builder().addContent(button).build();

Button myButton = (Button) box.getContents().get(0);

will fail.

To be able to get Button object from any layout element, fromLayoutElement method should be used, i.e.:

Button myButton = Button.fromLayoutElement(box.getContents().get(0));

Summary

Nested types
class Button.Builder : LayoutElementBuilders.LayoutElement.Builder This class is deprecated. Deprecated in Java

Public functions
java-static Button?	fromLayoutElement(element: LayoutElementBuilders.LayoutElement) This function is deprecated. Deprecated in Java
ButtonColors	getButtonColors() This function is deprecated. Deprecated in Java
ModifiersBuilders.Clickable	getClickable() This function is deprecated. Deprecated in Java
CharSequence?	getContentDescription() This function is deprecated. Deprecated in Java
LayoutElementBuilders.LayoutElement?	getCustomContent() This function is deprecated. Deprecated in Java
String?	getIconContent() This function is deprecated. Deprecated in Java
String?	getImageContent() This function is deprecated. Deprecated in Java
DimensionBuilders.ContainerDimension	getSize() This function is deprecated. Deprecated in Java
String?	getTextContent() This function is deprecated. Deprecated in Java

Public functions

fromLayoutElement

Added in 1.1.0

Deprecated in 1.2.0

java-static fun fromLayoutElement(element: LayoutElementBuilders.LayoutElement): Button?

This function is deprecated.
Deprecated in Java

Returns Button object from the given androidx.wear.tiles.LayoutElementBuilders.LayoutElement (e.g. one retrieved from a container's content with container.getContents().get(index)) if that element can be converted to Button. Otherwise, it will return null.

getButtonColors

Added in 1.1.0

Deprecated in 1.2.0

fun getButtonColors(): ButtonColors

This function is deprecated.
Deprecated in Java

Returns button color of this Button.

getClickable

Added in 1.1.0

Deprecated in 1.2.0

fun getClickable(): ModifiersBuilders.Clickable

This function is deprecated.
Deprecated in Java

Returns click event action associated with this Button.

getContentDescription

Added in 1.1.0

Deprecated in 1.2.0

fun getContentDescription(): CharSequence?

This function is deprecated.
Deprecated in Java

Returns content description for this Button.

getCustomContent

Added in 1.1.0

Deprecated in 1.2.0

fun getCustomContent(): LayoutElementBuilders.LayoutElement?

This function is deprecated.
Deprecated in Java

Returns the custom content of this Button if it has been added. Otherwise, it returns null.

getIconContent

Added in 1.1.0

Deprecated in 1.2.0

fun getIconContent(): String?

This function is deprecated.
Deprecated in Java

Returns the icon content of this Button if it has been added. Otherwise, it returns null.

getImageContent

Added in 1.1.0

Deprecated in 1.2.0

fun getImageContent(): String?

This function is deprecated.
Deprecated in Java

Returns the image content of this Button if it has been added. Otherwise, it returns null.

getSize

Added in 1.1.0

Deprecated in 1.2.0

fun getSize(): DimensionBuilders.ContainerDimension

This function is deprecated.
Deprecated in Java

Returns size for this Button.

getTextContent

Added in 1.1.0

Deprecated in 1.2.0

fun getTextContent(): String?

This function is deprecated.
Deprecated in Java

Returns the text content of this Button if it has been added. Otherwise, it returns null.