Header.Builder


class Header.Builder


A builder of Header.

Summary

Public constructors

Public functions

Header.Builder
addEndHeaderAction(headerAction: Action)

Adds an Action that will be displayed at the end of a header.

Header

Constructs the component defined by this builder.

Header.Builder

Sets the Action that will be displayed at the start of a header.

Header.Builder
setTitle(title: CarText)

Sets the title of the component, with support for multiple length variants.

Header.Builder

Sets the title of the component.

Public constructors

Builder

Added in 1.2.0
Builder()

Public functions

addEndHeaderAction

Added in 1.2.0
fun addEndHeaderAction(headerAction: Action): Header.Builder

Adds an Action that will be displayed at the end of a header.

Note: End header action will show up differently inside and outside of map-based templates.

  • In a Non-map screen (eg. MessageTemplate), actions appear as is, just as the app provides. A background color is allowed on the primary action.
  • In a Map-based screen (eg. Setting Header in the ContentTemplate in a MapWithContentTemplate) only actions with custom icons or standard actions will appear in the Header. The label will be stripped off each action if an app still provides that. Any tint on the icon will be disabled and default to neutral token. The background color on the primary action would also be removed.

build

Added in 1.2.0
fun build(): Header

Constructs the component defined by this builder.

Requirements

Either a start header Action or title must be set on the component.

Throws
java.lang.IllegalStateException

if neither a title nor start header Action is set

java.lang.IllegalArgumentException

if Actions towards the end of the header do not meet the template's requirements

setStartHeaderAction

Added in 1.2.0
fun setStartHeaderAction(headerAction: Action): Header.Builder

Sets the Action that will be displayed at the start of a header.

By default, a header will not have a start action.

Requirements Only one of APP_ICON or BACK is supported as a start header Action.
Throws
java.lang.IllegalArgumentException

if headerAction does not meet the requirements

java.lang.NullPointerException

if headerAction is null

setTitle

Added in 1.2.0
fun setTitle(title: CarText): Header.Builder

Sets the title of the component, with support for multiple length variants.

Only DistanceSpans and DurationSpans are supported in the input string.

Throws
java.lang.NullPointerException

if title is null

java.lang.IllegalArgumentException

if title contains unsupported spans

See also
CarText

setTitle

Added in 1.2.0
fun setTitle(title: CharSequence): Header.Builder

Sets the title of the component.

Only DistanceSpans and DurationSpans are supported in the input string.

Throws
java.lang.NullPointerException

if title is null

java.lang.IllegalArgumentException

if title contains unsupported spans

See also
CarText