Summary: XML Attrs | Inherited Constants | Methods | Protected Methods | Inherited Methods

TooltipDrawable

public class TooltipDrawable
extends MaterialShapeDrawable

java.lang.Object
↳	android.graphics.drawable.Drawable
	↳	com.google.android.material.shape.MaterialShapeDrawable
		↳	com.google.android.material.tooltip.TooltipDrawable

A Tooltip that supports shape theming and draws a pointer on the bottom in the center of the supplied bounds. Additional margin can be applied which will prevent the main bubble of the Tooltip from being drawn too close to the edge of the window.

Note: setRelativeToView(View) should be called so TooltipDrawable can calculate where it is being drawn within the visible display.

Summary

XML attributes
`Tooltip_android_layout_margin`
`Tooltip_android_minHeight`
`Tooltip_android_minWidth`
`Tooltip_android_padding`
`Tooltip_android_text`
`Tooltip_android_textAppearance`

Inherited constants

From class com.google.android.material.shape.MaterialShapeDrawable

`int`	`SHADOW_COMPAT_MODE_ALWAYS` Always draw fake shadows, never draw native elevation shadows.
`int`	`SHADOW_COMPAT_MODE_DEFAULT` Try to draw native elevation shadows if possible, otherwise use fake shadows.
`int`	`SHADOW_COMPAT_MODE_NEVER` Never draw fake shadows.

Public methods
`static TooltipDrawable`	`create(Context context)`
`static TooltipDrawable`	`createFromAttributes(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)` Returns a TooltipDrawable from the given attributes.
`static TooltipDrawable`	`createFromAttributes(Context context, AttributeSet attrs)` Returns a TooltipDrawable from the given attributes.
`void`	`detachView(View view)` Should be called when the view is detached from the screen.
`void`	`draw(Canvas canvas)`
`int`	`getIntrinsicHeight()`
`int`	`getIntrinsicWidth()`
`int`	`getLayoutMargin()` Returns the margin around the TooltipDrawable.
`int`	`getMinHeight()` Returns the minimum height of TooltipDrawable in terms of pixels.
`int`	`getMinWidth()` Returns the minimum width of TooltipDrawable in terms of pixels.
`CharSequence`	`getText()` Return the text that TooltipDrawable is displaying.
`TextAppearance`	`getTextAppearance()` Returns the TextAppearance used by this tooltip.
`int`	`getTextPadding()` Returns the padding between the text of TooltipDrawable and the sides in terms of pixels.
`boolean`	`onStateChange(int[] state)`
`void`	`onTextSizeChange()`
`void`	`setLayoutMargin(int layoutMargin)` Sets the margin around the TooltipDrawable to be `margin`.
`void`	`setMinHeight(int minHeight)` Sets the height of the TooltipDrawable to be at least `minHeight` wide.
`void`	`setMinWidth(int minWidth)` Sets the width of the TooltipDrawable to be at least `minWidth` wide.
`void`	`setRelativeToView(View view)` Should be called to allow this drawable to calculate its position within the current display frame.
`void`	`setRevealFraction(float fraction)` A fraction that controls the scale of the tooltip and the opacity of its text.
`void`	`setText(CharSequence text)` Sets the text to be displayed.
`void`	`setTextAppearance(TextAppearance textAppearance)` Sets this tooltip's text appearance.
`void`	`setTextAppearanceResource(int id)` Sets this tooltip's text appearance using a resource id.
`void`	`setTextPadding(int padding)` Sets the padding between the text of the TooltipDrawable and the sides to be `padding`.
`void`	`setTextResource(int id)` Sets the text to be displayed using a string resource identifier.

Protected methods
`void`	`onBoundsChange(Rect bounds)`

Inherited methods

From class


        
          com.google.android.material.shape.MaterialShapeDrawable

`int`	`compositeElevationOverlayIfNeeded(int backgroundColor)`
`static MaterialShapeDrawable`	`createWithElevationOverlay(Context context, float elevation)` Returns a `MaterialShapeDrawable` with the elevation overlay functionality initialized, a fill color of `colorSurface`, and an elevation of `elevation`.
`static MaterialShapeDrawable`	`createWithElevationOverlay(Context context)` Returns a `MaterialShapeDrawable` with the elevation overlay functionality initialized, a fill color of `colorSurface`, and an elevation of 0.
`void`	`draw(Canvas canvas)`
`float`	`getBottomLeftCornerResolvedSize()` Returns the actual size of the bottom left corner for the current bounds.
`float`	`getBottomRightCornerResolvedSize()` Returns the actual size of the bottom right corner for the current bounds.
`RectF`	`getBoundsAsRectF()`
`Drawable.ConstantState`	`getConstantState()`
`float`	`getElevation()` Returns the elevation used to render both fake shadows when `requiresCompatShadow()` is true and elevation overlays.
`ColorStateList`	`getFillColor()` Get the color used for the fill.
`float`	`getInterpolation()` Get the interpolation of the path, between 0 and 1.
`int`	`getOpacity()`
`void`	`getOutline(Outline outline)`
`boolean`	`getPadding(Rect padding)`
`Paint.Style`	`getPaintStyle()` Get the current style used by the shape's paint.
`float`	`getParentAbsoluteElevation()` Returns the parent absolute elevation.
`void`	`getPathForSize(int width, int height, Path path)` This method is deprecated. see `ShapeAppearancePathProvider`
`float`	`getScale()` Get the scale of the rendered path.
`int`	`getShadowCompatRotation()` Returns the rotation offset applied to the fake shadow which is drawn when `requiresCompatShadow()` is true.
`int`	`getShadowCompatibilityMode()`
`int`	`getShadowElevation()` This method is deprecated. use `getElevation()` instead.
`int`	`getShadowOffsetX()` Returns the X offset of the shadow from the bounds of the shape.
`int`	`getShadowOffsetY()` Returns the Y offset of the shadow from the bounds of the shape.
`int`	`getShadowRadius()` Get the shadow radius rendered by the path in pixels.
`ShapeAppearanceModel`	`getShapeAppearanceModel()` Get the `ShapeAppearanceModel` containing the path that will be rendered in this drawable.
`ShapePathModel`	`getShapedViewModel()` This method is deprecated. Use `getShapeAppearanceModel()` instead.
`ColorStateList`	`getStrokeColor()` Get the color used for the stroke.
`ColorStateList`	`getStrokeTintList()` Get the stroke's current `ColorStateList`.
`float`	`getStrokeWidth()` Get the stroke width used by the shape's paint.
`ColorStateList`	`getTintList()` Get the tint list used by the shape's paint.
`float`	`getTopLeftCornerResolvedSize()` Returns the actual size of the top left corner for the current bounds.
`float`	`getTopRightCornerResolvedSize()` Returns the actual size of the top right corner for the current bounds.
`float`	`getTranslationZ()` Returns the translationZ used to render both fake shadows when `requiresCompatShadow()` is true and elevation overlays.
`Region`	`getTransparentRegion()`
`float`	`getZ()` Returns the visual z position of this drawable, in pixels.
`void`	`initializeElevationOverlay(Context context)` Initializes the elevation overlay functionality for this drawable.
`void`	`invalidateSelf()`
`boolean`	`isElevationOverlayEnabled()` Returns whether the elevation overlay functionality is initialized and enabled in this drawable's theme context.
`boolean`	`isElevationOverlayInitialized()` Returns whether the elevation overlay functionality has been initialized for this drawable.
`boolean`	`isPointInTransparentRegion(int x, int y)` Determines whether a point is contained within the transparent region of the Drawable.
`boolean`	`isShadowEnabled()` This method is deprecated. use `getShadowCompatibilityMode()` instead
`boolean`	`isStateful()`
`Drawable`	`mutate()`
`void`	`onBoundsChange(Rect bounds)`
`boolean`	`onStateChange(int[] state)`
`boolean`	`requiresCompatShadow()` Returns true if fake shadows should be drawn.
`void`	`setAlpha(int alpha)`
`void`	`setColorFilter(ColorFilter colorFilter)`
`void`	`setCornerSize(float cornerSize)` Updates the corners for the given `CornerSize`.
`void`	`setCornerSize(CornerSize cornerSize)` Updates the corners for the given `CornerSize`.
`void`	`setEdgeIntersectionCheckEnable(boolean enable)`
`void`	`setElevation(float elevation)` Sets the elevation used to render both fake shadows when `requiresCompatShadow()` is true and elevation overlays.
`void`	`setFillColor(ColorStateList fillColor)` Set the color used for the fill.
`void`	`setInterpolation(float interpolation)` Set the interpolation of the path, between 0 and 1.
`void`	`setPadding(int left, int top, int right, int bottom)` Configure the padding of the shape
`void`	`setPaintStyle(Paint.Style paintStyle)` Set the style used by the shape's paint.
`void`	`setParentAbsoluteElevation(float parentAbsoluteElevation)` Sets the parent absolute elevation, which is used to render elevation overlays.
`void`	`setScale(float scale)` Set the scale of the rendered path.
`void`	`setShadowBitmapDrawingEnable(boolean enable)`
`void`	`setShadowColor(int shadowColor)` Set the color of fake shadow rendered behind the shape.
`void`	`setShadowCompatRotation(int shadowRotation)` Set the rotation offset applied to the fake shadow which is drawn when `requiresCompatShadow()` is true.
`void`	`setShadowCompatibilityMode(int mode)` Set the shadow compatibility mode.
`void`	`setShadowElevation(int shadowElevation)` This method is deprecated. use `setElevation(float)` instead.
`void`	`setShadowEnabled(boolean shadowEnabled)` This method is deprecated. use `setShadowCompatibilityMode(int)` instead.
`void`	`setShadowRadius(int shadowRadius)` This method is deprecated. use `setElevation(float)` instead.
`void`	`setShapeAppearanceModel(ShapeAppearanceModel shapeAppearanceModel)` Set the `ShapeAppearanceModel` containing the path that will be rendered in this drawable.
`void`	`setShapedViewModel(ShapePathModel shapedViewModel)` This method is deprecated. Use `setShapeAppearanceModel(ShapeAppearanceModel)` instead.
`void`	`setStroke(float strokeWidth, ColorStateList strokeColor)` Set the shape's stroke width and stroke color using a `ColorStateList`.
`void`	`setStroke(float strokeWidth, int strokeColor)` Set the shape's stroke width and stroke color.
`void`	`setStrokeColor(ColorStateList strokeColor)` Set the color used for the stroke.
`void`	`setStrokeTint(ColorStateList tintList)` Set the shape's stroke `ColorStateList`
`void`	`setStrokeTint(int tintColor)` Set the shape's stroke color.
`void`	`setStrokeWidth(float strokeWidth)` Set the stroke width used by the shape's paint.
`void`	`setTint(int tintColor)`
`void`	`setTintList(ColorStateList tintList)`
`void`	`setTintMode(PorterDuff.Mode tintMode)`
`void`	`setTranslationZ(float translationZ)` Sets the translationZ used to render both fake shadows when `requiresCompatShadow()` is true and elevation overlays.
`void`	`setUseTintColorForShadow(boolean useTintColorForShadow)` Set whether fake shadow color should match next set tint color.
`void`	`setZ(float z)` Sets the visual z position of this view, in pixels.

From class


        
          android.graphics.drawable.Drawable

`void`	`applyTheme(Resources.Theme arg0)`
`boolean`	`canApplyTheme()`
`void`	`clearColorFilter()`
`final Rect`	`copyBounds()`
`final void`	`copyBounds(Rect arg0)`
`static Drawable`	`createFromPath(String arg0)`
`static Drawable`	`createFromResourceStream(Resources arg0, TypedValue arg1, InputStream arg2, String arg3, BitmapFactory.Options arg4)`
`static Drawable`	`createFromResourceStream(Resources arg0, TypedValue arg1, InputStream arg2, String arg3)`
`static Drawable`	`createFromStream(InputStream arg0, String arg1)`
`static Drawable`	`createFromXml(Resources arg0, XmlPullParser arg1)`
`static Drawable`	`createFromXml(Resources arg0, XmlPullParser arg1, Resources.Theme arg2)`
`static Drawable`	`createFromXmlInner(Resources arg0, XmlPullParser arg1, AttributeSet arg2, Resources.Theme arg3)`
`static Drawable`	`createFromXmlInner(Resources arg0, XmlPullParser arg1, AttributeSet arg2)`
`abstract void`	`draw(Canvas arg0)`
`int`	`getAlpha()`
`final Rect`	`getBounds()`
`Drawable.Callback`	`getCallback()`
`int`	`getChangingConfigurations()`
`ColorFilter`	`getColorFilter()`
`Drawable.ConstantState`	`getConstantState()`
`Drawable`	`getCurrent()`
`Rect`	`getDirtyBounds()`
`void`	`getHotspotBounds(Rect arg0)`
`int`	`getIntrinsicHeight()`
`int`	`getIntrinsicWidth()`
`int`	`getLayoutDirection()`
`final int`	`getLevel()`
`int`	`getMinimumHeight()`
`int`	`getMinimumWidth()`
`abstract int`	`getOpacity()`
`Insets`	`getOpticalInsets()`
`void`	`getOutline(Outline arg0)`
`boolean`	`getPadding(Rect arg0)`
`int[]`	`getState()`
`Region`	`getTransparentRegion()`
`void`	`inflate(Resources arg0, XmlPullParser arg1, AttributeSet arg2, Resources.Theme arg3)`
`void`	`inflate(Resources arg0, XmlPullParser arg1, AttributeSet arg2)`
`void`	`invalidateSelf()`
`boolean`	`isAutoMirrored()`
`boolean`	`isFilterBitmap()`
`boolean`	`isProjected()`
`boolean`	`isStateful()`
`final boolean`	`isVisible()`
`void`	`jumpToCurrentState()`
`Drawable`	`mutate()`
`void`	`onBoundsChange(Rect arg0)`
`boolean`	`onLayoutDirectionChanged(int arg0)`
`boolean`	`onLevelChange(int arg0)`
`boolean`	`onStateChange(int[] arg0)`
`static int`	`resolveOpacity(int arg0, int arg1)`
`void`	`scheduleSelf(Runnable arg0, long arg1)`
`abstract void`	`setAlpha(int arg0)`
`void`	`setAutoMirrored(boolean arg0)`
`void`	`setBounds(int arg0, int arg1, int arg2, int arg3)`
`void`	`setBounds(Rect arg0)`
`final void`	`setCallback(Drawable.Callback arg0)`
`void`	`setChangingConfigurations(int arg0)`
`void`	`setColorFilter(int arg0, PorterDuff.Mode arg1)`
`abstract void`	`setColorFilter(ColorFilter arg0)`
`void`	`setDither(boolean arg0)`
`void`	`setFilterBitmap(boolean arg0)`
`void`	`setHotspot(float arg0, float arg1)`
`void`	`setHotspotBounds(int arg0, int arg1, int arg2, int arg3)`
`final boolean`	`setLayoutDirection(int arg0)`
`final boolean`	`setLevel(int arg0)`
`boolean`	`setState(int[] arg0)`
`void`	`setTint(int arg0)`
`void`	`setTintBlendMode(BlendMode arg0)`
`void`	`setTintList(ColorStateList arg0)`
`void`	`setTintMode(PorterDuff.Mode arg0)`
`boolean`	`setVisible(boolean arg0, boolean arg1)`
`void`	`unscheduleSelf(Runnable arg0)`

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

From interface


        
          androidx.core.graphics.drawable.TintAwareDrawable

`abstract void`	`setTint(int arg0)`
`abstract void`	`setTintList(ColorStateList arg0)`
`abstract void`	`setTintMode(PorterDuff.Mode arg0)`

From interface


        
          com.google.android.material.shape.Shapeable

`abstract ShapeAppearanceModel`	`getShapeAppearanceModel()` Returns the `ShapeAppearanceModel` used for the shape definition.
`abstract void`	`setShapeAppearanceModel(ShapeAppearanceModel shapeAppearanceModel)` Sets the `ShapeAppearanceModel` that defines the shape.

XML attributes

Related methods:

setLayoutMargin(int)

Related methods:

setMinHeight(int)

Related methods:

setMinWidth(int)

Related methods:

setTextPadding(int)

Related methods:

setTextResource(int)

Related methods:

setTextAppearanceResource(int)

Public methods

create

public static TooltipDrawable create (Context context)

Parameters
`context`	`Context`

Returns
`TooltipDrawable`

createFromAttributes

public static TooltipDrawable createFromAttributes (Context context, 
                AttributeSet attrs, 
                int defStyleAttr, 
                int defStyleRes)

Returns a TooltipDrawable from the given attributes.

Parameters
`context`	`Context`
`attrs`	`AttributeSet`
`defStyleAttr`	`int`
`defStyleRes`	`int`

Returns
`TooltipDrawable`

createFromAttributes

public static TooltipDrawable createFromAttributes (Context context, 
                AttributeSet attrs)

Returns a TooltipDrawable from the given attributes.

Parameters
`context`	`Context`
`attrs`	`AttributeSet`

Returns
`TooltipDrawable`

detachView

public void detachView (View view)

Should be called when the view is detached from the screen.

Parameters
`view`	`View`

See also:

setRelativeToView(View)

draw

public void draw (Canvas canvas)

Parameters
`canvas`	`Canvas`

getIntrinsicHeight

public int getIntrinsicHeight ()

Returns
`int`

getIntrinsicWidth

public int getIntrinsicWidth ()

Returns
`int`

getLayoutMargin

public int getLayoutMargin ()

Returns the margin around the TooltipDrawable.

Related XML Attributes:

Tooltip_android_layout_margin

Returns
`int`

See also:

setLayoutMargin(int)

getMinHeight

public int getMinHeight ()

Returns the minimum height of TooltipDrawable in terms of pixels.

Related XML Attributes:

Tooltip_android_minHeight

Returns
`int`

See also:

setMinHeight(int)

getMinWidth

public int getMinWidth ()

Returns the minimum width of TooltipDrawable in terms of pixels.

Related XML Attributes:

Tooltip_android_minWidth

Returns
`int`

See also:

setMinWidth(int)

getText

public CharSequence getText ()

Return the text that TooltipDrawable is displaying.

Related XML Attributes:

Tooltip_android_text

Returns
`CharSequence`

getTextAppearance

public TextAppearance getTextAppearance ()

Returns the TextAppearance used by this tooltip.

Related XML Attributes:

Tooltip_android_textAppearance

Returns
`TextAppearance`

getTextPadding

public int getTextPadding ()

Returns the padding between the text of TooltipDrawable and the sides in terms of pixels.

Related XML Attributes:

Tooltip_android_padding

Returns
`int`

See also:

setTextPadding(int)

onStateChange

public boolean onStateChange (int[] state)

Parameters
`state`	`int`

Returns
`boolean`

onTextSizeChange

public void onTextSizeChange ()

setLayoutMargin

public void setLayoutMargin (int layoutMargin)

Sets the margin around the TooltipDrawable to be margin.

Related XML Attributes:

Tooltip_android_layout_margin

Parameters
`layoutMargin`	`int`: the margin to use around the TooltipDrawable

See also:

getLayoutMargin()

setMinHeight

public void setMinHeight (int minHeight)

Sets the height of the TooltipDrawable to be at least minHeight wide.

Related XML Attributes:

Tooltip_android_minHeight

Parameters
`minHeight`	`int`: the minimum height of TooltipDrawable in terms of pixels

See also:

getMinHeight()

setMinWidth

public void setMinWidth (int minWidth)

Sets the width of the TooltipDrawable to be at least minWidth wide.

Related XML Attributes:

Tooltip_android_minWidth

Parameters
`minWidth`	`int`: the minimum width of TooltipDrawable in terms of pixels

See also:

getMinWidth()

setRelativeToView

public void setRelativeToView (View view)

Should be called to allow this drawable to calculate its position within the current display frame. This allows it to apply to specified window padding.

Parameters
`view`	`View`

See also:

detachView(View)

setRevealFraction

public void setRevealFraction (float fraction)

A fraction that controls the scale of the tooltip and the opacity of its text.

When fraction is 0.0, the tooltip will be completely hidden, as fraction approaches 1.0, the tooltip will scale up from its pointer and animate in its text.

This method is typically called from within an animator's update callback. The animator in this case is what is driving the animation while this method handles configuring the tooltip's appearance at each frame in the animation.

Parameters
`fraction`	`float`: A value between 0.0 and 1.0 that defines how "shown" the tooltip will be.

setText

public void setText (CharSequence text)

Sets the text to be displayed.

Related XML Attributes:

Tooltip_android_text

Parameters
`text`	`CharSequence`: text to be displayed

See also:

setTextResource(int)

setTextAppearance

public void setTextAppearance (TextAppearance textAppearance)

Sets this tooltip's text appearance.

Related XML Attributes:

Tooltip_android_textAppearance

Parameters
`textAppearance`	`TextAppearance`: This tooltip's text appearance.

setTextAppearanceResource

public void setTextAppearanceResource (int id)

Sets this tooltip's text appearance using a resource id.

Related XML Attributes:

Tooltip_android_textAppearance

Parameters
`id`	`int`: The resource id of this tooltip's text appearance.

setTextPadding

public void setTextPadding (int padding)

Sets the padding between the text of the TooltipDrawable and the sides to be padding.

Related XML Attributes:

Tooltip_android_padding

Parameters
`padding`	`int`: the padding to use around the text

See also:

getTextPadding()

setTextResource

public void setTextResource (int id)

Sets the text to be displayed using a string resource identifier.

Related XML Attributes:

Tooltip_android_text

Parameters
`id`	`int`: the resource identifier of the string resource to be displayed

See also:

setText(CharSequence)

Protected methods

onBoundsChange

protected void onBoundsChange (Rect bounds)

Parameters
`bounds`	`Rect`

TooltipDrawable

Summary

XML attributes

Inherited constants

Public methods

Protected methods

Inherited methods

XML attributes

Tooltip_android_layout_margin

Tooltip_android_minHeight

Tooltip_android_minWidth

Tooltip_android_padding

Tooltip_android_text

Tooltip_android_textAppearance

Public methods

create

createFromAttributes

createFromAttributes

detachView

draw

getIntrinsicHeight

getIntrinsicWidth

getLayoutMargin

getMinHeight

getMinWidth

getText

getTextAppearance

getTextPadding

onStateChange

onTextSizeChange

setLayoutMargin

setMinHeight

setMinWidth

setRelativeToView

setRevealFraction

setText

setTextAppearance

setTextAppearanceResource

setTextPadding

setTextResource

Protected methods

onBoundsChange