Action.Builder


class Action.Builder


A builder of Action.

Summary

Public constructors

Creates an empty Builder instance.

@RequiresCarApi(value = 2)
Builder(action: Action)

Returns a Builder instance configured with the same data as the given Action instance.

Public functions

Action

Constructs the Action defined by this builder.

Action.Builder
setBackgroundColor(backgroundColor: CarColor)

Sets the background color to be used for the action.

Action.Builder
@RequiresCarApi(value = 5)
setEnabled(enabled: Boolean)

Sets the initial enabled state for Action.

Action.Builder
@RequiresCarApi(value = 4)
setFlags(flags: Int)

Sets flags affecting how this action should be treated.

Action.Builder

Sets the icon to display in the action.

Action.Builder

Sets the OnClickListener to call when the action is clicked.

Action.Builder
setTitle(title: CarText)

Sets the title to display in the action, with support for multiple length variants.

Action.Builder

Sets the title to display in the action.

Public constructors

Builder

Added in 1.0.0
Builder()

Creates an empty Builder instance.

Builder

Added in 1.1.0
@RequiresCarApi(value = 2)
Builder(action: Action)

Returns a Builder instance configured with the same data as the given Action instance.

Throws
java.lang.NullPointerException

if action is null

Public functions

build

Added in 1.0.0
fun build(): Action

Constructs the Action defined by this builder.

Throws
java.lang.IllegalStateException

if the action is not a standard action and does not have an icon or a title, if a listener is set on either APP_ICON or BACK, or if an icon or title is set on either APP_ICON or BACK

setBackgroundColor

Added in 1.0.0
fun setBackgroundColor(backgroundColor: CarColor): Action.Builder

Sets the background color to be used for the action.

Requirements

Depending on contrast requirements, capabilities of the vehicle screens, or other factors, the color may be ignored by the host or overridden by the vehicle system. See the documentation on where the Action is added for more details on any other restriction(s) that might apply.

Parameters
backgroundColor: CarColor

the CarColor to set as background. Use DEFAULT to let the host pick a default

Throws
java.lang.NullPointerException

if backgroundColor is null

setEnabled

Added in 1.3.0
@RequiresCarApi(value = 5)
fun setEnabled(enabled: Boolean): Action.Builder

Sets the initial enabled state for Action.

The default state of a Action is enabled.

setFlags

Added in 1.1.0
@RequiresCarApi(value = 4)
fun setFlags(flags: Int): Action.Builder

Sets flags affecting how this action should be treated.

setIcon

Added in 1.0.0
fun setIcon(icon: CarIcon): Action.Builder

Sets the icon to display in the action.

Unless set with this method, the action will not have an icon.

Icon Sizing Guidance To minimize scaling artifacts across a wide range of car screens, apps should provide icons targeting a 88 x 88 dp bounding box. If the icon exceeds this maximum size in either one of the dimensions, it will be scaled down to be centered inside the bounding box while preserving its aspect ratio.

See CarIcon for more details related to providing icon and image resources that work with different car screen pixel densities.

Throws
java.lang.NullPointerException

if icon is null

setOnClickListener

Added in 1.0.0
fun setOnClickListener(listener: OnClickListener): Action.Builder

Sets the OnClickListener to call when the action is clicked.

Unless set with this method, the action will not have a click listener.

Note that the listener relates to UI events and will be executed on the main thread using getMainLooper.

Throws
java.lang.NullPointerException

if listener is null

setTitle

Added in 1.0.0
fun setTitle(title: CarText): Action.Builder

Sets the title to display in the action, with support for multiple length variants.

Support for text spans depends on where the action is used. For example, most templates taking an action support ForegroundCarColorSpan, but this may vary. See the documentation of the specific APIs taking an Action for details.

Throws
java.lang.NullPointerException

if title is null

See also
CarText

setTitle

Added in 1.0.0
fun setTitle(title: CharSequence): Action.Builder

Sets the title to display in the action.

Support for text spans depends on where the action is used. See the documentation of the specific APIs taking an Action for details.

Throws
java.lang.NullPointerException

if title is null