SESL Material/com.google.android.material.tooltip/TooltipDrawable

TooltipDrawable

@RestrictTo(value = LIBRARY_GROUP)
open class TooltipDrawable : MaterialShapeDrawable, TextDrawableHelper.TextDrawableDelegate

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 should be called so TooltipDrawable can calculate where it is being drawn within the visible display.

Properties

Link copied to clipboard
open var layoutMargin: Int
Link copied to clipboard
open var minHeight: Int
Link copied to clipboard
open var minWidth: Int
Link copied to clipboard

Functions

Link copied to clipboard
@NonNull
open fun create(@NonNull context: Context): TooltipDrawable
Link copied to clipboard
@NonNull
open fun createFromAttributes(@NonNull context: Context, @Nullable attrs: AttributeSet): TooltipDrawable
@NonNull
open fun createFromAttributes(@NonNull context: Context, @Nullable attrs: AttributeSet, @AttrRes defStyleAttr: Int, @StyleRes defStyleRes: Int): TooltipDrawable
Returns a TooltipDrawable from the given attributes.
Link copied to clipboard
open fun detachView(@Nullable view: View)
Should be called when the view is detached from the screen.
Link copied to clipboard
open fun draw(@NonNull canvas: Canvas)
Link copied to clipboard
open fun getIntrinsicHeight(): Int
Link copied to clipboard
open fun getIntrinsicWidth(): Int
Link copied to clipboard
@Nullable
open fun getTextAppearance(): TextAppearance
Returns the TextAppearance used by this tooltip.
Link copied to clipboard
open fun getTextPadding(): Int
Returns the padding between the text of TooltipDrawable and the sides in terms of pixels.
Link copied to clipboard
open fun onStateChange(state: Array<Int>): Boolean
Link copied to clipboard
open fun onTextSizeChange()
Handles a change in the text's size.
Link copied to clipboard
open fun setRelativeToView(@Nullable view: View)
Should be called to allow this drawable to calculate its position within the current display frame.
Link copied to clipboard
open fun setRevealFraction(@FloatRange(from = 0.0, to = 1.0) fraction: Float)
A fraction that controls the scale of the tooltip and the opacity of its text.
Link copied to clipboard
open fun setTextAppearance(@Nullable textAppearance: TextAppearance)
Sets this tooltip's text appearance.
Link copied to clipboard
open fun setTextAppearanceResource(@StyleRes id: Int)
Sets this tooltip's text appearance using a resource id.
Link copied to clipboard
open fun setTextPadding(@Px padding: Int)
Sets the padding between the text of the TooltipDrawable and the sides to be padding.
Link copied to clipboard
open fun setTextResource(@StringRes id: Int)
Sets the text to be displayed using a string resource identifier.