public
final
class
Tile
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.service.quicksettings.Tile |
A Tile holds the state of a tile that will be displayed in Quick Settings. A tile in Quick Settings exists as an icon with an accompanied label. It also may have content description for accessibility usability. The style and layout of the tile may change to match a given device.
Constants | |
---|---|
int |
STATE_ACTIVE
This represents a tile that is currently active. |
int |
STATE_INACTIVE
This represents a tile that is currently in a disabled state but is still interactable. |
int |
STATE_UNAVAILABLE
An unavailable state indicates that for some reason this tile is not currently available to the user for some reason, and will have no click action. |
Inherited constants |
---|
From
interface
android.os.Parcelable
|
Fields | |
---|---|
public
static
final
Creator<Tile> |
CREATOR
|
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
CharSequence
|
getContentDescription()
Gets the current content description for the tile. |
Icon
|
getIcon()
Gets the current icon for the tile. |
CharSequence
|
getLabel()
Gets the current label for the tile. |
int
|
getState()
The current state of the tile. |
void
|
setContentDescription(CharSequence contentDescription)
Sets the current content description for the tile. |
void
|
setIcon(Icon icon)
Sets the current icon for the tile. |
void
|
setLabel(CharSequence label)
Sets the current label for the tile. |
void
|
setState(int state)
Sets the current state for the tile. |
void
|
updateTile()
Pushes the state of the Tile to Quick Settings to be displayed. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
From
class
java.lang.Object
| |
From
interface
android.os.Parcelable
|
int STATE_ACTIVE
This represents a tile that is currently active. (e.g. wifi is connected, bluetooth is on, cast is casting). This is the default state.
Constant Value: 2 (0x00000002)
int STATE_INACTIVE
This represents a tile that is currently in a disabled state but is still interactable. A disabled state indicates that the tile is not currently active (e.g. wifi disconnected or bluetooth disabled), but is still interactable by the user to modify this state. Tiles that have boolean states should use this to represent one of their states. The tile's icon will be tinted differently to reflect this state, but still be distinct from unavailable.
Constant Value: 1 (0x00000001)
int STATE_UNAVAILABLE
An unavailable state indicates that for some reason this tile is not currently available to the user for some reason, and will have no click action. The tile's icon will be tinted differently to reflect this state.
Constant Value: 0 (0x00000000)
int describeContents ()
Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of writeToParcel(Parcel, int)
,
the return value of this method must include the
CONTENTS_FILE_DESCRIPTOR
bit.
Returns | |
---|---|
int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. |
CharSequence getContentDescription ()
Gets the current content description for the tile.
Returns | |
---|---|
CharSequence |
CharSequence getLabel ()
Gets the current label for the tile.
Returns | |
---|---|
CharSequence |
void setContentDescription (CharSequence contentDescription)
Sets the current content description for the tile.
Does not take effect until updateTile()
is called.
Parameters | |
---|---|
contentDescription |
CharSequence :
New content description to use.
|
void setIcon (Icon icon)
Sets the current icon for the tile.
This icon is expected to be white on alpha, and may be
tinted by the system to match it's theme.
Does not take effect until updateTile()
is called.
Parameters | |
---|---|
icon |
Icon :
New icon to show.
|
void setLabel (CharSequence label)
Sets the current label for the tile.
Does not take effect until updateTile()
is called.
Parameters | |
---|---|
label |
CharSequence :
New label to show.
|
void setState (int state)
Sets the current state for the tile.
Does not take effect until updateTile()
is called.
Parameters | |
---|---|
state |
int :
One of STATE_UNAVAILABLE , STATE_INACTIVE ,
STATE_ACTIVE
|
void updateTile ()
Pushes the state of the Tile to Quick Settings to be displayed.
void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
Parameters | |
---|---|
dest |
Parcel :
The Parcel in which the object should be written. |
flags |
int :
Additional flags about how the object should be written.
May be 0 or PARCELABLE_WRITE_RETURN_VALUE .
|