ToggleRangeTemplate


public final class ToggleRangeTemplate
extends ControlTemplate

java.lang.Object
   ↳ android.service.controls.templates.ControlTemplate
     ↳ android.service.controls.templates.ToggleRangeTemplate


A template for a Control supporting toggling and a range.

Summary

Inherited constants

int TYPE_ERROR

Type identifier of the template returned by getErrorTemplate().

int TYPE_NO_TEMPLATE

Type identifier of ControlTemplate.getNoTemplateObject.

int TYPE_RANGE

Type identifier of RangeTemplate.

int TYPE_STATELESS

Type identifier of StatelessTemplate.

int TYPE_TEMPERATURE

Type identifier of TemperatureControlTemplate.

int TYPE_THUMBNAIL

Type identifier of ThumbnailTemplate.

int TYPE_TOGGLE

Type identifier of ToggleTemplate.

int TYPE_TOGGLE_RANGE

Type identifier of ToggleRangeTemplate.

Public constructors

ToggleRangeTemplate(String templateId, ControlButton button, RangeTemplate range)

Constructs a new ToggleRangeTemplate.

ToggleRangeTemplate(String templateId, boolean checked, CharSequence actionDescription, RangeTemplate range)

Constructs a new ToggleRangeTemplate.

Public methods

CharSequence getActionDescription()
RangeTemplate getRange()
int getTemplateType()

The template type associated with this class.

boolean isChecked()

Inherited methods

static ControlTemplate getErrorTemplate()
static ControlTemplate getNoTemplateObject()

Get a singleton ControlTemplate, which supports no direct user input.

String getTemplateId()
abstract int getTemplateType()

The template type associated with this class.

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

ToggleRangeTemplate

Added in API level 30
public ToggleRangeTemplate (String templateId, 
                ControlButton button, 
                RangeTemplate range)

Constructs a new ToggleRangeTemplate.

Parameters
templateId String: the identifier for this template. This value cannot be null.

button ControlButton: a ControlButton to use for the toggle interface This value cannot be null.

range RangeTemplate: a RangeTemplate to use for the range interface This value cannot be null.

ToggleRangeTemplate

Added in API level 30
public ToggleRangeTemplate (String templateId, 
                boolean checked, 
                CharSequence actionDescription, 
                RangeTemplate range)

Constructs a new ToggleRangeTemplate.

Parameters
templateId String: the identifier for this template. This value cannot be null.

checked boolean: true if the toggle should be rendered as active.

actionDescription CharSequence: action description for the button. This value cannot be null.

range RangeTemplate: RangeTemplate to use for the range interface This value cannot be null.

See also:

Public methods

getActionDescription

Added in API level 30
public CharSequence getActionDescription ()

Returns
CharSequence This value cannot be null.

getRange

Added in API level 30
public RangeTemplate getRange ()

Returns
RangeTemplate This value cannot be null.

getTemplateType

Added in API level 30
public int getTemplateType ()

The template type associated with this class.

isChecked

Added in API level 30
public boolean isChecked ()

Returns
boolean