StateSet | API reference | Android Developers

Summary: Fields | Methods | Inherited Methods

public class StateSet
extends Object

State sets are arrays of positive ints where each element represents the state of a View (e.g. focused, selected, visible, etc.). A View may be in one or more of those states. A state spec is an array of signed ints where each element represents a required (if positive) or an undesired (if negative) View state. Utils dealing with state sets. In theory we could encapsulate the state set and state spec arrays and not have static methods here but there is some concern about performance since these methods are called during view drawing.

Summary

Fields
`public static final int[]`	`NOTHING` A state set that does not contain any valid states.
`public static final int[]`	`WILD_CARD` A state specification that will be matched by all StateSets.

Public methods
`static String`	`dump(int[] states)`
`static boolean`	`isWildCard(int[] stateSetOrSpec)` Return whether the stateSetOrSpec is matched by all StateSets.
`static boolean`	`stateSetMatches(int[] stateSpec, int[] stateSet)` Return whether the stateSet matches the desired stateSpec.
`static boolean`	`stateSetMatches(int[] stateSpec, int state)` Return whether the state matches the desired stateSpec.
`static int[]`	`trimStateSet(int[] states, int newSize)`

Inherited methods

From class java.lang.Object

`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.

Fields

NOTHING

public static final int[] NOTHING

A state set that does not contain any valid states.

WILD_CARD

public static final int[] WILD_CARD

A state specification that will be matched by all StateSets.

Public methods

dump

public static String dump (int[] states)

Parameters
`states`	`int`

Returns
`String`

isWildCard

public static boolean isWildCard (int[] stateSetOrSpec)

Return whether the stateSetOrSpec is matched by all StateSets.

Parameters
`stateSetOrSpec`	`int`: a state set or state spec.

Returns
`boolean`

stateSetMatches

public static boolean stateSetMatches (int[] stateSpec, 
                int[] stateSet)

Return whether the stateSet matches the desired stateSpec.

Parameters
`stateSpec`	`int`: an array of required (if positive) or prohibited (if negative) `View` states.
`stateSet`	`int`: an array of `View` states

Returns
`boolean`

stateSetMatches

public static boolean stateSetMatches (int[] stateSpec, 
                int state)

Return whether the state matches the desired stateSpec.

Parameters
`stateSpec`	`int`: an array of required (if positive) or prohibited (if negative) `View` states.
`state`	`int`: a `View` state

Returns
`boolean`

trimStateSet

public static int[] trimStateSet (int[] states, 
                int newSize)

Parameters
`states`	`int`
`newSize`	`int`

Returns
`int[]`

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.