# SplitAttributes.Builder

# SplitAttributes.Builder

Artifact:[androidx.window:window](https://developer.android.com/jetpack/androidx/releases/window)  
[View Source](https://cs.android.com/search?q=file:androidx/window/embedding/SplitAttributes.kt+class:androidx.window.embedding.SplitAttributes.Builder)  
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/window#1.1.0)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/window/embedding/SplitAttributes.Builder "View this page in Java")

<br />

```
class SplitAttributes.Builder
```

<br />

*** ** * ** ***

Builder for creating an instance of[SplitAttributes](https://developer.android.com/reference/kotlin/androidx/window/embedding/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](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.Builder#Builder())`()` |

|                                                    ### Public functions                                                     |
|-----------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [SplitAttributes](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes)                 | [build](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.Builder#build())`()` Builds a`SplitAttributes`instance with the attributes specified by[setSplitType](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.Builder#setSplitType(androidx.window.embedding.SplitAttributes.SplitType)),[setLayoutDirection](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.Builder#setLayoutDirection(androidx.window.embedding.SplitAttributes.LayoutDirection)), and[setAnimationParams](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.Builder#setAnimationParams(androidx.window.embedding.EmbeddingAnimationParams)). |
| [SplitAttributes.Builder](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.Builder) | `@`[RequiresWindowSdkExtension](https://developer.android.com/reference/kotlin/androidx/window/RequiresWindowSdkExtension)`(version = 5)` [setAnimationParams](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.Builder#setAnimationParams(androidx.window.embedding.EmbeddingAnimationParams))`(params: `[EmbeddingAnimationParams](https://developer.android.com/reference/kotlin/androidx/window/embedding/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](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.Builder) | `@`[RequiresWindowSdkExtension](https://developer.android.com/reference/kotlin/androidx/window/RequiresWindowSdkExtension)`(version = 6)` [setDividerAttributes](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.Builder#setDividerAttributes(androidx.window.embedding.DividerAttributes))`(dividerAttributes: `[DividerAttributes](https://developer.android.com/reference/kotlin/androidx/window/embedding/DividerAttributes)`)` Sets the[DividerAttributes](https://developer.android.com/reference/kotlin/androidx/window/embedding/DividerAttributes)for this split.                                                                                                                                                                |
| [SplitAttributes.Builder](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.Builder) | [setLayoutDirection](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.Builder#setLayoutDirection(androidx.window.embedding.SplitAttributes.LayoutDirection))`(layoutDirection: `[SplitAttributes.LayoutDirection](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.LayoutDirection)`)` Sets the split layout direction attribute.                                                                                                                                                                                                                                                                                                                                                                  |
| [SplitAttributes.Builder](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.Builder) | [setSplitType](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.Builder#setSplitType(androidx.window.embedding.SplitAttributes.SplitType))`(type: `[SplitAttributes.SplitType](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.SplitType)`)` Sets the split type attribute.                                                                                                                                                                                                                                                                                                                                                                                                                       |

## Public constructors

### Builder

Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/window#1.1.0)  

```
Builder()
```  

## Public functions

### build

Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/window#1.1.0)  

```
fun build(): SplitAttributes
```

Builds a`SplitAttributes`instance with the attributes specified by[setSplitType](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.Builder#setSplitType(androidx.window.embedding.SplitAttributes.SplitType)),[setLayoutDirection](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.Builder#setLayoutDirection(androidx.window.embedding.SplitAttributes.LayoutDirection)), and[setAnimationParams](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.Builder#setAnimationParams(androidx.window.embedding.EmbeddingAnimationParams)).  

|                                                   Returns                                                   |
|-------------------------------------------------------------------------------------------------------------|-----------------------------------|
| [SplitAttributes](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes) | The new`SplitAttributes`instance. |

### setAnimationParams

Added in[1.4.0](https://developer.android.com/jetpack/androidx/releases/window#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](https://developer.android.com/reference/kotlin/androidx/window/embedding/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](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingAnimationParams)on a target device that has lower API level.  

|                                                               Parameters                                                                |
|-----------------------------------------------------------------------------------------------------------------------------------------|-----------------------|
| `params: `[EmbeddingAnimationParams](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingAnimationParams) | the animation params. |

|                                                           Returns                                                           |
|-----------------------------------------------------------------------------------------------------------------------------|----------------|
| [SplitAttributes.Builder](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.Builder) | this`Builder`. |

### setDividerAttributes

Added in[1.4.0](https://developer.android.com/jetpack/androidx/releases/window#1.4.0)  

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

Sets the[DividerAttributes](https://developer.android.com/reference/kotlin/androidx/window/embedding/DividerAttributes)for this split.

The default is[DividerAttributes.NO_DIVIDER](https://developer.android.com/reference/kotlin/androidx/window/embedding/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](https://developer.android.com/reference/kotlin/androidx/window/embedding/DividerAttributes) | The divider attributes. |

|                                                           Returns                                                           |
|-----------------------------------------------------------------------------------------------------------------------------|----------------|
| [SplitAttributes.Builder](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.Builder) | This`Builder`. |

### setLayoutDirection

Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/window#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](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.LayoutDirection) | The layout direction attribute. |

|                                                           Returns                                                           |
|-----------------------------------------------------------------------------------------------------------------------------|----------------|
| [SplitAttributes.Builder](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.Builder) | This`Builder`. |

|                                                                  See also                                                                   |
|---------------------------------------------------------------------------------------------------------------------------------------------|---|
| [SplitAttributes.LayoutDirection](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.LayoutDirection) |   |

### setSplitType

Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/window#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](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.SplitType) | The split type attribute. |

|                                                           Returns                                                           |
|-----------------------------------------------------------------------------------------------------------------------------|----------------|
| [SplitAttributes.Builder](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.Builder) | This`Builder`. |

|                                                            See also                                                             |
|---------------------------------------------------------------------------------------------------------------------------------|---|
| [SplitAttributes.SplitType](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes.SplitType) |   |