SplitAttributes.Builder

Added in 1.1.0

Kotlin |Java

class SplitAttributes.Builder

Builder for creating an instance of SplitAttributes.

The default split type is an equal split between primary and secondary containers.
The default layout direction is based on locale.
The default animation params is to use the current theme window background color and system transitions.
The default divider attributes is not to use divider.

Summary

Public constructors
`Builder()`

Public functions
`SplitAttributes`	`build()` Builds a `SplitAttributes` instance with the attributes specified by `setSplitType`, `setLayoutDirection`, and `setAnimationParams`.
`SplitAttributes.Builder`	`@RequiresWindowSdkExtension(version = 5) setAnimationParams(params: EmbeddingAnimationParams)` Sets the animation params to use during animation of the split involving this `SplitAttributes` object if the animation requires a background color or non-default transitions.
`SplitAttributes.Builder`	`@RequiresWindowSdkExtension(version = 6) setDividerAttributes(dividerAttributes: DividerAttributes)` Sets the `DividerAttributes` for this split.
`SplitAttributes.Builder`	`setLayoutDirection(layoutDirection: SplitAttributes.LayoutDirection)` Sets the split layout direction attribute.
`SplitAttributes.Builder`	`setSplitType(type: SplitAttributes.SplitType)` Sets the split type attribute.

Public constructors

Builder

Added in 1.1.0

Builder()

Public functions

build

Added in 1.1.0

fun build(): SplitAttributes

Builds a SplitAttributes instance with the attributes specified by setSplitType, setLayoutDirection, and setAnimationParams.

Returns
`SplitAttributes`	The new `SplitAttributes` instance.

setAnimationParams

Added in 1.4.0

@RequiresWindowSdkExtension(version = 5)
fun setAnimationParams(params: EmbeddingAnimationParams): SplitAttributes.Builder

Sets the animation params to use during animation of the split involving this SplitAttributes object if the animation requires a background color or non-default transitions.

EmbeddingAnimationParams can be supported only if the Window Extensions version of the target device is equals or higher than required API level. Otherwise, it would be no-op when setting the EmbeddingAnimationParams on a target device that has lower API level.

Parameters
`params: EmbeddingAnimationParams`	the animation params.

Returns
`SplitAttributes.Builder`	this `Builder`.

setDividerAttributes

Added in 1.4.0

@RequiresWindowSdkExtension(version = 6)
fun setDividerAttributes(dividerAttributes: DividerAttributes): SplitAttributes.Builder

Sets the DividerAttributes for this split.

The default is DividerAttributes.NO_DIVIDER, which means no divider is requested.

Divider can be supported only if the Window Extensions version of the target device is equals or higher than required API level. Otherwise, it would be no-op on a target device that has lower API level.

Parameters
`dividerAttributes: DividerAttributes`	The divider attributes.

Returns
`SplitAttributes.Builder`	This `Builder`.

setLayoutDirection

Added in 1.1.0

fun setLayoutDirection(layoutDirection: SplitAttributes.LayoutDirection): SplitAttributes.Builder

Sets the split layout direction attribute.

The default is based on locale.

Parameters
`layoutDirection: SplitAttributes.LayoutDirection`	The layout direction attribute.

Returns
`SplitAttributes.Builder`	This `Builder`.

See also
`SplitAttributes.LayoutDirection`

setSplitType

Added in 1.1.0

fun setSplitType(type: SplitAttributes.SplitType): SplitAttributes.Builder

Sets the split type attribute.

The default is an equal split between primary and secondary containers.

Parameters
`type: SplitAttributes.SplitType`	The split type attribute.

Returns
`SplitAttributes.Builder`	This `Builder`.

See also
`SplitAttributes.SplitType`