TitleChip
class TitleChip : LayoutElementBuilders.LayoutElement
ProtoLayout component TitleChip that represents clickable object with the text.
The Title Chip is Stadium shaped object with a larger height then standard Chip and it will take one line of text of TYPOGRAPHY_TITLE2 style.
The recommended set of ChipColors styles can be obtained from ChipDefaults, e.g. TITLE_PRIMARY_COLORS to get a color scheme for a primary .
When accessing the contents of a container for testing, note that this element can't be simply casted back to the original type, i.e.:
TitleChip chip = new TitleChip... Box box = new Box.Builder().addContent(chip).build(); TitleChip myChip = (TitleChip) box.getContents().get(0);will fail.
To be able to get TitleChip object from any layout element, fromLayoutElement method should be used, i.e.:
TitleChip myChip = TitleChip.fromLayoutElement(box.getContents().get(0));
| See also | |
|---|---|
setContent |
if this TitleChip is used inside of |
Summary
Nested types |
|---|
class TitleChip.BuilderBuilder class for |
Public functions |
|
|---|---|
java-static TitleChip? |
Returns TitleChip object from the given LayoutElement (e.g. one retrieved from a container's content with |
ChipColors |
Returns chip color of this Chip. |
ModifiersBuilders.Clickable |
Returns click event action associated with this Chip. |
TypeBuilders.StringProp? |
Returns content description of this TitleChip. |
Int |
Returns the horizontal alignment of the content in this Chip. |
String? |
Returns icon id from this TitleChip if it has been added. |
String |
getText()Returns text content of this Chip. |
DimensionBuilders.ContainerDimension |
getWidth()Returns width of this Chip. |
Public functions
fromLayoutElement
java-static fun fromLayoutElement(element: LayoutElementBuilders.LayoutElement): TitleChip?
Returns TitleChip object from the given LayoutElement (e.g. one retrieved from a container's content with container.getContents().get(index)) if that element can be converted to TitleChip. Otherwise, it will return null.
getClickable
fun getClickable(): ModifiersBuilders.Clickable
Returns click event action associated with this Chip.
getContentDescription
fun getContentDescription(): TypeBuilders.StringProp?
Returns content description of this TitleChip.
getHorizontalAlignment
fun getHorizontalAlignment(): Int
Returns the horizontal alignment of the content in this Chip.
getIconContent
fun getIconContent(): String?
Returns icon id from this TitleChip if it has been added. Otherwise, it returns null.
getWidth
fun getWidth(): DimensionBuilders.ContainerDimension
Returns width of this Chip.