1.12.0+1.0.31-sesl8+rev0

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

ChipGroup

open class ChipGroup : FlowLayout

A ChipGroup is used to hold multiple Chips. By default, the chips are reflowed across multiple lines. Set the app:singleLine attribute to constrain the chips to a single horizontal line. If you do so, you'll usually want to wrap this ChipGroup in a .

ChipGroup also supports a multiple-exclusion scope for a set of chips. When you set the app:singleSelection attribute, checking one chip that belongs to a chip group unchecks any previously checked chip within the same group. The behavior mirrors that of .

When a chip is added to a chip group, its checked state will be preserved. If the chip group is in the single selection mode and there is an existing checked chip when another checked chip is added, the existing checked chip will be unchecked to maintain the single selection rule.

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

Inheritors

Constructors

constructor(context: Context)

constructor(context: Context, attrs: AttributeSet)

constructor(context: Context, attrs: AttributeSet, defStyleAttr: Int)

Types

open class LayoutParams : ViewGroup.MarginLayoutParams

A ChipGroup.LayoutParams implementation for ChipGroup.

OnCheckedChangeListener

interface ~~OnCheckedChangeListener~~

Interface definition for a callback to be invoked when the checked chip changed in this group.

OnCheckedStateChangeListener

interface OnCheckedStateChangeListener

Interface definition for a callback which supports multiple checked IDs to be invoked when the checked chips changed in this group.

Properties

chipSpacingHorizontal

open var chipSpacingHorizontal: Int

chipSpacingVertical

open var chipSpacingVertical: Int

Functions

open fun check(@IdRes id: Int)

Sets the selection to the chip whose identifier is passed in parameter.

open fun clearCheck()

Clears the selection.

generateLayoutParams

open fun generateLayoutParams(attrs: AttributeSet): ViewGroup.LayoutParams

getCheckedChipId

open fun getCheckedChipId(): Int

When in single selection mode, returns the identifier of the selected chip in this group.

getCheckedChipIds

open fun getCheckedChipIds(): List<Integer>

Returns the identifiers of the selected Chips in this group.

isSelectionRequired

open fun isSelectionRequired(): Boolean

Returns whether we prevent all child chips from being deselected.

open fun isSingleLine(): Boolean

Returns whether this chip group is single line or reflowed multiline.

isSingleSelection

open fun isSingleSelection(): Boolean

Returns whether this chip group only allows a single chip to be checked.

onInitializeAccessibilityNodeInfo

open fun onInitializeAccessibilityNodeInfo(@NonNull info: AccessibilityNodeInfo)

open fun setChipSpacing(@Dimension chipSpacing: Int)

Sets the horizontal and vertical spacing between visible chips in this group.

setChipSpacingHorizontalResource

open fun setChipSpacingHorizontalResource(@DimenRes id: Int)

Sets the horizontal spacing between visible chips in this group.

setChipSpacingResource

open fun setChipSpacingResource(@DimenRes id: Int)

Sets the horizontal and vertical spacing between visible chips in this group.

setChipSpacingVerticalResource

open fun setChipSpacingVerticalResource(@DimenRes id: Int)

Sets the vertical spacing between visible chips in this group.

setDividerDrawableHorizontal

open fun ~~setDividerDrawableHorizontal~~(divider: Drawable)

setDividerDrawableVertical

open fun ~~setDividerDrawableVertical~~(@Nullable divider: Drawable)

open fun ~~setFlexWrap~~(flexWrap: Int)

setOnCheckedChangeListener

open fun ~~setOnCheckedChangeListener~~(@Nullable listener: ChipGroup.OnCheckedChangeListener)

Register a callback to be invoked when the checked chip changes in this group.

setOnCheckedStateChangeListener

open fun setOnCheckedStateChangeListener(@Nullable listener: ChipGroup.OnCheckedStateChangeListener)

Register a callback to be invoked when the checked chip changes in this group.

setOnHierarchyChangeListener

open fun setOnHierarchyChangeListener(listener: ViewGroup.OnHierarchyChangeListener)

setSelectionRequired

open fun setSelectionRequired(selectionRequired: Boolean)

Sets whether we prevent all child chips from being deselected.

setShowDividerHorizontal

open fun ~~setShowDividerHorizontal~~(dividerMode: Int)

setShowDividerVertical

open fun ~~setShowDividerVertical~~(dividerMode: Int)

open fun setSingleLine(singleLine: Boolean)

open fun setSingleLine(@BoolRes id: Int)

Sets whether this chip group is single line, or reflowed multiline.

setSingleSelection

open fun setSingleSelection(singleSelection: Boolean)

open fun setSingleSelection(@BoolRes id: Int)

Sets whether this chip group only allows a single chip to be checked.