RangeTemplate


public final class RangeTemplate
extends ControlTemplate

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


A template for a Control with inputs in a "continuous" range of values.

See also:

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

RangeTemplate(String templateId, float minValue, float maxValue, float currentValue, float stepValue, CharSequence formatString)

Construct a new RangeTemplate.

Public methods

float getCurrentValue()

The current value for this range.

CharSequence getFormatString()

Formatter for generating a user visible String representing the value returned by RangeTemplate#getCurrentValue.

float getMaxValue()

The maximum value for this range.

float getMinValue()

The minimum value for this range.

float getStepValue()

The value of the smallest increment or decrement that can be performed on this range.

int getTemplateType()

The template type associated with this class.

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

RangeTemplate

Added in API level 30
public RangeTemplate (String templateId, 
                float minValue, 
                float maxValue, 
                float currentValue, 
                float stepValue, 
                CharSequence formatString)

Construct a new RangeTemplate. The range must be valid, meaning:

  • minValue < maxValue
  • minValue < currentValue
  • currentValue < maxValue
  • 0 < stepValue

The current value of the Control will be formatted accordingly.

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

minValue float: minimum value for the input

maxValue float: maximum value for the input

currentValue float: the current value of the Control containing this object.

stepValue float: minimum value of increments/decrements when interacting with this control.

formatString CharSequence: a formatting string as per String#format used to display the currentValue. If null is passed, the "%.1f" is used.

Throws
IllegalArgumentException if the parameters passed do not make a valid range.

Public methods

getCurrentValue

Added in API level 30
public float getCurrentValue ()

The current value for this range.

Returns
float

getFormatString

Added in API level 30
public CharSequence getFormatString ()

Formatter for generating a user visible String representing the value returned by RangeTemplate#getCurrentValue.

Returns
CharSequence a formatting string as specified in String#format This value cannot be null.

getMaxValue

Added in API level 30
public float getMaxValue ()

The maximum value for this range.

Returns
float

getMinValue

Added in API level 30
public float getMinValue ()

The minimum value for this range.

Returns
float

getStepValue

Added in API level 30
public float getStepValue ()

The value of the smallest increment or decrement that can be performed on this range.

Returns
float

getTemplateType

Added in API level 30
public int getTemplateType ()

The template type associated with this class.

android is a command-line tool located in the tools directory of the Android SDK.

Updated Apr 12, 2023

The GoogleApiClient class has been replaced by the GoogleApi class.

Updated Nov 12, 2024

Discover the latest app development tools, platform updates, training, and documentation for developers across every Android device.

Updated Apr 4, 2024