WindowId

Kotlin |Java

open class WindowId : Parcelable

kotlin.Any
↳	android.view.WindowId

Safe identifier for a window. This currently allows you to retrieve and observe the input focus state of the window. Most applications will not use this, instead relying on the simpler (and more efficient) methods available on View. This classes is useful when window input interactions need to be done across processes: the class itself is a Parcelable that can be passed to other processes for them to interact with your window, and it provides a limited safe API that doesn't allow the other process to negatively harm your window.

Summary

Nested classes
abstract	`FocusObserver` Subclass for observing changes to the focus state of an `WindowId`.

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
open Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
open Boolean	`equals(other: Any?)` Comparison operator on two IntentSender objects, such that true is returned then they both represent the same operation from the same package.
open Int	`hashCode()` Returns a hash code value for the object.
open Boolean	`isFocused()` Retrieve the current focus state of the associated window.
open Unit	`registerFocusObserver(observer: WindowId.FocusObserver!)` Start monitoring for changes in the focus state of the window.
open String	`toString()` Returns a string representation of the object.
open Unit	`unregisterFocusObserver(observer: WindowId.FocusObserver!)` Stop monitoring changes in the focus state of the window.
open Unit	`writeToParcel(out: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<WindowId!>	`CREATOR`

Public methods

describeContents

Added in API level 18

open fun describeContents(): Int

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(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 18

open fun equals(other: Any?): Boolean

Comparison operator on two IntentSender objects, such that true is returned then they both represent the same operation from the same package.

Parameters
`obj`	the reference object with which to compare.
`otherObj`	This value may be `null`.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

hashCode

Added in API level 18

open fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Return
`Int`	a hash code value for this object.

isFocused

Added in API level 18

open fun isFocused(): Boolean

Retrieve the current focus state of the associated window.

registerFocusObserver

Added in API level 18

open fun registerFocusObserver(observer: WindowId.FocusObserver!): Unit

Start monitoring for changes in the focus state of the window.

toString

Added in API level 18

open fun toString(): String

Returns a string representation of the object.

Return
`String`	a string representation of the object.

unregisterFocusObserver

Added in API level 18

open fun unregisterFocusObserver(observer: WindowId.FocusObserver!): Unit

Stop monitoring changes in the focus state of the window.

writeToParcel

Added in API level 18

open fun writeToParcel(
    out: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
`dest`	The Parcel in which the object should be written. This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `PARCELABLE_WRITE_RETURN_VALUE`

Properties

CREATOR

Added in API level 18

static val CREATOR: Parcelable.Creator<WindowId!>