Most visited

Recently visited

Added in API level 18

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

From interface android.os.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

From class java.lang.Object
From interface android.os.Parcelable

Fields

CREATOR

Added in API level 18
Creator<WindowId> CREATOR

Public methods

describeContents

Added in API level 18
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(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.

equals

Added in API level 18
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: the reference object with which to compare.
Returns
boolean true if this object is the same as the obj argument; false otherwise.

hashCode

Added in API level 18
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(Object) 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(java.lang.Object) 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Returns
int a hash code value for this object.

isFocused

Added in API level 18
boolean isFocused ()

Retrieve the current focus state of the associated window.

Returns
boolean

registerFocusObserver

Added in API level 18
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
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

unregisterFocusObserver

Added in API level 18
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
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.
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.

Hooray!