ByWindowSelector

public @NonNull ByWindowSelector active(boolean isActive)

Sets the search criteria to match windows that are active or inactive.

@RequiresApi(value = 30)
public @NonNull ByWindowSelector displayId(int displayId)

Adds a display ID selector criteria for matching. A UI element will be considered a match if it is within the display with the ID of displayId and all other criteria for this selector are met.

public @NonNull ByWindowSelector focused(boolean isFocused)

Sets the search criteria to match windows that are focused or not.

public @NonNull ByWindowSelector id(int id)

Sets the id criteria for matching. A UI window will be considered a match if its id matches the id parameter and all other criteria for this selector are met.

public @NonNull ByWindowSelector layer(@IntRange(from = 0) int exactLayer)

Sets the layer (Z-order) criteria for matching. A UI window will be considered a match if its layer matches the layer parameter and all other criteria for this selector are met.

public @NonNull ByWindowSelector layerAbove(@IntRange(from = 0) int referenceLayer)

Sets the layer (Z-order) criteria for finding windows that are layered above the specified reference layer.

public @NonNull ByWindowSelector layerBelow(@IntRange(from = 1) int referenceLayer)

Sets the layer (Z-order) criteria for finding windows that are layered below the specified reference layer.

public @NonNull ByWindowSelector pkg(@NonNull Pattern packageName)

Sets the package name criteria for window matching. A UI window will be considered a match if its package name exactly matches the packageName and all other criteria for this selector are met.

public @NonNull ByWindowSelector pkg(@NonNull String packageName)

Sets the package name criteria for window matching. A UI window will be considered a match if its package name exactly matches the packageName and all other criteria for this selector are met.

public @NonNull ByWindowSelector title(@NonNull Pattern title)

Sets the title criteria for matching. A UI window will be considered a match if its title matches the titlePattern and all other criteria for this selector are met.

public @NonNull ByWindowSelector title(@NonNull String title)

Sets the title criteria for matching. A UI window will be considered a match if its title exactly matches the title parameter and all other criteria for this selector are met.

public @NonNull ByWindowSelector titleContains(@NonNull String substring)

Sets the title criteria for matching. A UI window will be considered a match if its title contains the substring and all other criteria for this selector are met.

public @NonNull ByWindowSelector titleEndsWith(@NonNull String suffix)

Sets the title criteria for matching. A UI window will be considered a match if its title ends with the suffix and all other criteria for this selector are met.

public @NonNull ByWindowSelector titleStartsWith(@NonNull String prefix)

Sets the title criteria for matching. A UI window will be considered a match if its title starts with the prefix and all other criteria for this selector are met.

public @NonNull String toString()

Returns a String representation of this ByWindowSelector. The format is "ByWindowSelector [='', ... ]". Each criteria is listed as a key-value pair where the key is the name of the criteria expressed in all caps (e.g. TYPE, TITLE, etc).

public @NonNull ByWindowSelector type(int type)

Sets the type criteria for window matching. A UI window will be considered a match if its type exactly matches the type and all other criteria for this selector are met.