lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey
added in API level 18

ViewOverlay

public class ViewOverlay
extends Object

java.lang.Object
   ↳ android.view.ViewOverlay


An overlay is an extra layer that sits on top of a View (the "host view") which is drawn after all other content in that view (including children, if the view is a ViewGroup). Interaction with the overlay layer is done by adding and removing drawables.

An overlay requested from a ViewGroup is of type ViewGroupOverlay, which also supports adding and removing views.

Summary

Public methods

void add(Drawable drawable)

Adds a Drawable to the overlay.

void clear()

Removes all content from the overlay.

void remove(Drawable drawable)

Removes the specified Drawable from the overlay.

Inherited methods

Public methods

add

added in API level 18
public void add (Drawable drawable)

Adds a Drawable to the overlay. The bounds of the drawable should be relative to the host view. Any drawable added to the overlay should be removed when it is no longer needed or no longer visible. Adding an already existing Drawable is a no-op. Passing null parameter will result in an IllegalArgumentException being thrown.

Parameters
drawable Drawable: The Drawable to be added to the overlay. This drawable will be drawn when the view redraws its overlay. Drawables will be drawn in the order that they were added.

This value must never be null.

See also:

clear

added in API level 18
public void clear ()

Removes all content from the overlay.

remove

added in API level 18
public void remove (Drawable drawable)

Removes the specified Drawable from the overlay. Removing a Drawable that was not added with add(Drawable) is a no-op. Passing null parameter will result in an IllegalArgumentException being thrown.

Parameters
drawable Drawable: The Drawable to be removed from the overlay.

This value must never be null.

See also: