WindowId


public class WindowId
extends Object implements Parcelable

java.lang.Object
   ↳ 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

class WindowId.FocusObserver

Subclass for observing changes to the focus state of an WindowId

Inherited constants

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(Parcel, int): 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)".

Fields

public static final Creator<WindowId> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object otherObj)

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

int hashCode()

Returns a hash code value for the object.

boolean isFocused()

Retrieve the current focus state of the associated window.

void registerFocusObserver(WindowId.FocusObserver observer)

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

String toString()

Returns a string representation of the object.

void unregisterFocusObserver(WindowId.FocusObserver observer)

Stop monitoring changes in the focus state of the window.

void writeToParcel(Parcel out, int flags)

Flatten this object in to a Parcel.

Inherited methods

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.

abstract int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

abstract void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 18
public static final Creator<WindowId> CREATOR

Public methods

describeContents

Added in API level 18
public 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(android.os.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. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 18
public boolean equals (Object otherObj)

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

Parameters
otherObj Object: This value may be null.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

hashCode

Added in API level 18
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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.

Returns
int a hash code value for this object.

isFocused

Added in API level 18
public boolean isFocused ()

Retrieve the current focus state of the associated window.

Returns
boolean

registerFocusObserver

Added in API level 18
public void registerFocusObserver (WindowId.FocusObserver observer)

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

Parameters
observer WindowId.FocusObserver

toString

Added in API level 18
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

unregisterFocusObserver

Added in API level 18
public void unregisterFocusObserver (WindowId.FocusObserver observer)

Stop monitoring changes in the focus state of the window.

Parameters
observer WindowId.FocusObserver

writeToParcel

Added in API level 18
public void writeToParcel (Parcel out, 
                int flags)

Flatten this object in to a Parcel.

Parameters
out Parcel: 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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES