SESL Material/com.google.android.material.chip/ChipDrawable

ChipDrawable

open class ChipDrawable : MaterialShapeDrawable, TintAwareDrawable, Drawable.Callback, TextDrawableHelper.TextDrawableDelegate

SESL variant ChipDrawable contains all the layout and draw logic for Chip.

You can use ChipDrawable directly in contexts that require a Drawable. For example, an auto-complete enabled EditText can replace snippets of text with a ChipDrawable to represent it as a semantic entity. To create an instance of ChipDrawable, use createFromResource and pass in an XML resource in this form:


<chip xmlns:app="http://schemas.android.com/apk/res-auto"
    android:text="Hello, World!"/>

The basic attributes you can set are:

android:checkable - If true, the chip can be toggled. If false, the chip acts like a button.
android:text - Sets the text of the chip.
app:chipIcon - Sets the icon of the chip, or use @null to display no icon. Usually on the left.
app:checkedIcon - Sets a custom icon to use when checked, or use @null to display no icon. Usually on the left.
app:closeIcon - Sets a custom icon that the user can click to close, or use @null to display no icon. Usually on the right.
ellipsize - Does not support MARQUEE because chip text should not scroll.

When used in this stand-alone mode, the host view must explicitly manage the ChipDrawable's state:

setBounds, taking into account getIntrinsicHeight and getIntrinsicWidth.
draw
setCallback, to support invalidations on the chip drawable or any of its child drawables. This includes animations.
setState, to support checking the chip, and touch/mouse/keyboard interactions on the chip.
setCloseIconState, to support touch, mouse, or keyboard interactions on the close icon.
setHotspot
setLayoutDirection, to support RTL mode.

ChipDrawable's horizontal layout is as follows:

  chipStartPadding     iconEndPadding     closeIconStartPadding         chipEndPadding
   +                    +                                    +                      +
   |                    |                                    |                      |
   |  iconStartPadding  |  textStartPadding   textEndPadding | closeIconEndPadding  |
   |   +                |    +                            +  |                  +   |
   |   |                |    |                            |  |                  |   |
   v   v                v    v                            v  v                  v   v
+-----+----+-----------+----+----+---------------------+----+----+----------+----+-----+
|     |    |       XX  |    |    |  XX   X  X  X  XXX  |    |    | X      X |    |     |
|     |    |      XX   |    |    | X  X  X  X  X  X  X |    |    |  XX  XX  |    |     |
|     |    |  XX XX    |    |    | X     XXXX  X  XXX  |    |    |    XX    |    |     |
|     |    |   XXX     |    |    | X  X  X  X  X  X    |    |    |  XX  XX  |    |     |
|     |    |    X      |    |    |  XX   X  X  X  X    |    |    | X      X |    |     |
+-----+----+-----------+----+----+---------------------+----+----+----------+----+-----+
                 ^                           ^                         ^
                 |                           |                         |
                 +                           +                         +
            chipIconSize                  *dynamic*              closeIconSize

ChipDrawable contains three child drawables: chipIcon, checkedIcon, and closeIcon. chipIcon and checkedIcon inherit the state of this drawable, but closeIcon contains its own state that you can set with setCloseIconState.

For more information, see the component developer guidance and design guidelines.

Types

Delegate

interface Delegate

Delegate interface to be implemented by Views that own a ChipDrawable.

Properties

alpha

open var alpha: Int

checkedIcon

@Nullable

@get:Nullable

open var checkedIcon: Drawable

checkedIconTint

@Nullable

@get:Nullable

open var checkedIconTint: ColorStateList

chipBackgroundColor

@Nullable

@get:Nullable

open var chipBackgroundColor: ColorStateList

chipCornerRadius

open var chipCornerRadius: Float

chipEndPadding

open var chipEndPadding: Float

Padding at the end of the chip, after the close icon.

chipIcon

@Nullable

@get:Nullable

open var chipIcon: Drawable

chipIconSize

open var chipIconSize: Float

chipIconTint

@Nullable

@get:Nullable

open var chipIconTint: ColorStateList

chipMinHeight

open var chipMinHeight: Float

chipStartPadding

open var chipStartPadding: Float

Padding at the start of the chip, before the icon.

chipStrokeColor

@Nullable

@get:Nullable

open var chipStrokeColor: ColorStateList

chipStrokeWidth

open var chipStrokeWidth: Float

closeIcon

@Nullable

@get:Nullable

open var closeIcon: Drawable

closeIconContentDescription

@Nullable

@get:Nullable

open var closeIconContentDescription: CharSequence

closeIconEndPadding

open var closeIconEndPadding: Float

Padding at the end of the close icon, before the end of the chip.

closeIconSize

open var closeIconSize: Float

closeIconStartPadding

open var closeIconStartPadding: Float

Padding at the start of the close icon, after the text.

closeIconTint

@Nullable

@get:Nullable

open var closeIconTint: ColorStateList

colorFilter

@Nullable

@get:Nullable

open var colorFilter: ColorFilter

hideMotionSpec

@Nullable

@get:Nullable

open var hideMotionSpec: MotionSpec

iconEndPadding

open var iconEndPadding: Float

Padding at the end of the icon, before the text.

iconStartPadding

open var iconStartPadding: Float

Padding at the start of the icon, after the start of the chip.

isSeslFullText

open var isSeslFullText: Boolean

maxWidth

@get:Px

open var maxWidth: Int

rippleColor

@Nullable

@get:Nullable

open var rippleColor: ColorStateList

seslFinalWidth

open var seslFinalWidth: Float

showMotionSpec

@Nullable

@get:Nullable

open var showMotionSpec: MotionSpec

text

@Nullable

@get:Nullable

open var text: CharSequence

textEndPadding

open var textEndPadding: Float

Padding at the end of the text, before the close icon.

textStartPadding

open var textStartPadding: Float

Padding at the start of the text, after the icon.

useCompatRipple

open var useCompatRipple: Boolean

Functions

createFromAttributes

@NonNull

open fun createFromAttributes(@NonNull context: Context, @Nullable attrs: AttributeSet, @AttrRes defStyleAttr: Int, @StyleRes defStyleRes: Int): ChipDrawable

Returns a ChipDrawable from the given attributes.

createFromResource

@NonNull

open fun createFromResource(@NonNull context: Context, @XmlRes id: Int): ChipDrawable

Returns a ChipDrawable from the given XML resource.

draw

open fun draw(@NonNull canvas: Canvas)

getChipTouchBounds

open fun getChipTouchBounds(@NonNull bounds: RectF)

Returns the chip's ChipDrawable-absolute bounds (top-left is


   [ChipDrawable.getBounds().left, ChipDrawable.getBounds().top]

getCloseIconState

@NonNull

open fun getCloseIconState(): Array<Int>

Describes the current state of the close icon.

getCloseIconTouchBounds

open fun getCloseIconTouchBounds(@NonNull bounds: RectF)

Returns the close icon's ChipDrawable-absolute bounds (top-left is


   [ChipDrawable.getBounds().left, ChipDrawable.getBounds().top]

getEllipsize

open fun getEllipsize(): TextUtils.TruncateAt

getIntrinsicHeight

open fun getIntrinsicHeight(): Int

Returns the height at which the chip would like to be laid out.

getIntrinsicWidth

open fun getIntrinsicWidth(): Int

Returns the width at which the chip would like to be laid out.

getOpacity

open fun getOpacity(): Int

getOutline

open fun getOutline(@NonNull outline: Outline)

getTextAppearance

@Nullable

open fun getTextAppearance(): TextAppearance

invalidateDrawable

open fun invalidateDrawable(@NonNull who: Drawable)

isCheckable

open fun isCheckable(): Boolean

isCheckedIconEnabled

open fun ~~isCheckedIconEnabled~~(): Boolean

isCheckedIconVisible

open fun isCheckedIconVisible(): Boolean

isChipIconEnabled

open fun ~~isChipIconEnabled~~(): Boolean

isChipIconVisible

open fun isChipIconVisible(): Boolean

isCloseIconEnabled

open fun ~~isCloseIconEnabled~~(): Boolean

isCloseIconStateful

open fun isCloseIconStateful(): Boolean

Indicates whether the close icon drawable will change its appearance based on state.

isCloseIconVisible

open fun isCloseIconVisible(): Boolean

isStateful

open fun isStateful(): Boolean

Indicates whether this chip drawable will change its appearance based on state.

onLayoutDirectionChanged

open fun onLayoutDirectionChanged(layoutDirection: Int): Boolean

onStateChange

open fun onStateChange(@NonNull state: Array<Int>): Boolean

onTextSizeChange

open fun onTextSizeChange()

Handles a change in the text's size.

scheduleDrawable

open fun scheduleDrawable(@NonNull who: Drawable, @NonNull what: Runnable, when: Long)

setCheckable

open fun setCheckable(checkable: Boolean)

setCheckableResource

open fun setCheckableResource(@BoolRes id: Int)

setCheckedIconEnabled

open fun ~~setCheckedIconEnabled~~(checkedIconEnabled: Boolean)

setCheckedIconEnabledResource

open fun ~~setCheckedIconEnabledResource~~(@BoolRes id: Int)

setCheckedIconResource

open fun setCheckedIconResource(@DrawableRes id: Int)

Sets this chip's checked icon using a resource id.

setCheckedIconTintResource

open fun setCheckedIconTintResource(@ColorRes id: Int)

Sets the checked icon's color tint using a resource ID.

setCheckedIconVisible

open fun setCheckedIconVisible(checkedIconVisible: Boolean)

open fun setCheckedIconVisible(@BoolRes id: Int)

setChipBackgroundColorResource

open fun setChipBackgroundColorResource(@ColorRes id: Int)

Sets this chip's background color using a resource id.

setChipCornerRadiusResource

open fun ~~setChipCornerRadiusResource~~(@DimenRes id: Int)

setChipEndPaddingResource

open fun setChipEndPaddingResource(@DimenRes id: Int)

Sets this chip's end padding using a resource id.

setChipIconEnabled

open fun ~~setChipIconEnabled~~(chipIconEnabled: Boolean)

setChipIconEnabledResource

open fun ~~setChipIconEnabledResource~~(@BoolRes id: Int)

setChipIconResource

open fun setChipIconResource(@DrawableRes id: Int)

setChipIconSizeResource

open fun setChipIconSizeResource(@DimenRes id: Int)

Sets this chip icon's size using a resource id.

setChipIconTintResource

open fun setChipIconTintResource(@ColorRes id: Int)

Sets the chip icon's color tint using a resource ID.

setChipIconVisible

open fun setChipIconVisible(chipIconVisible: Boolean)

open fun setChipIconVisible(@BoolRes id: Int)

setChipMinHeightResource

open fun setChipMinHeightResource(@DimenRes id: Int)

Sets this chip's minimum height using a resource id.

setChipStartPaddingResource

open fun setChipStartPaddingResource(@DimenRes id: Int)

Sets this chip's start padding using a resource id.

setChipStrokeColorResource

open fun setChipStrokeColorResource(@ColorRes id: Int)

Sets this chip's stroke color using a resource id.

setChipStrokeWidthResource

open fun setChipStrokeWidthResource(@DimenRes id: Int)

Sets this chip's stroke width using a resource id.

setCloseIconEnabled

open fun ~~setCloseIconEnabled~~(closeIconEnabled: Boolean)

setCloseIconEnabledResource

open fun ~~setCloseIconEnabledResource~~(@BoolRes id: Int)

setCloseIconEndPaddingResource

open fun setCloseIconEndPaddingResource(@DimenRes id: Int)

Sets the end padding for this chip's close icon using a resource id.

setCloseIconResource

open fun setCloseIconResource(@DrawableRes id: Int)

setCloseIconSizeResource

open fun setCloseIconSizeResource(@DimenRes id: Int)

setCloseIconStartPaddingResource

open fun setCloseIconStartPaddingResource(@DimenRes id: Int)

Sets the start padding for this chip's close icon using a resource id.

setCloseIconState

open fun setCloseIconState(@NonNull stateSet: Array<Int>): Boolean

Specify a set of states for the close icon.

setCloseIconTintResource

open fun setCloseIconTintResource(@ColorRes id: Int)

setCloseIconVisible

open fun setCloseIconVisible(closeIconVisible: Boolean)

open fun setCloseIconVisible(@BoolRes id: Int)

setDelegate

open fun setDelegate(@Nullable delegate: ChipDrawable.Delegate)

Sets the View delegate that owns this ChipDrawable.

setEllipsize

open fun setEllipsize(@Nullable truncateAt: TextUtils.TruncateAt)

setHideMotionSpecResource

open fun setHideMotionSpecResource(@AnimatorRes id: Int)

Sets this chip's hide motion spec using a resource id.

setIconEndPaddingResource

open fun setIconEndPaddingResource(@DimenRes id: Int)

Sets the end padding for this chip's icon using a resource id.

setIconStartPaddingResource

open fun setIconStartPaddingResource(@DimenRes id: Int)

Sets the start padding for this chip's icon using a resource id.

setRippleColorResource

open fun setRippleColorResource(@ColorRes id: Int)

Sets this chip's ripple color using a resource id.

setShowMotionSpecResource

open fun setShowMotionSpecResource(@AnimatorRes id: Int)

Sets this chip's show motion spec using a resource id.

setTextAppearance

open fun setTextAppearance(@Nullable textAppearance: TextAppearance)

setTextAppearanceResource

open fun setTextAppearanceResource(@StyleRes id: Int)

setTextColor

open fun setTextColor(@Nullable color: ColorStateList)

open fun setTextColor(@ColorInt color: Int)

setTextEndPaddingResource

open fun setTextEndPaddingResource(@DimenRes id: Int)

Sets the end padding for this chip's text using a resource id.

setTextResource

open fun setTextResource(@StringRes id: Int)

setTextSize

open fun setTextSize(@Dimension size: Float)

setTextStartPaddingResource

open fun setTextStartPaddingResource(@DimenRes id: Int)

Sets the start padding for this chip's text using a resource id.

setTintList

open fun setTintList(@Nullable tint: ColorStateList)

setTintMode

open fun setTintMode(@NonNull tintMode: PorterDuff.Mode)

setVisible

open fun setVisible(visible: Boolean, restart: Boolean): Boolean

unscheduleDrawable

open fun unscheduleDrawable(@NonNull who: Drawable, @NonNull what: Runnable)

ChipDrawable

See also

Types

Properties

Functions