Interface UILUTCheckBoxBuilder<BackgroundType>

Interface for 'LUTCheckBox'-builder.

Type Parameters

BackgroundType extends UIBackground = UIBackground

Hierarchy

UIElementBuilder<UILUTCheckBox<BackgroundType>>
- UILUTCheckBoxBuilder

Index

Methods

addStyler setAlignment setBackground setButtonShape

Methods

addStyler

addStyler(styler: UIElementStyler<UILUTCheckBox<BackgroundType>>): UILUTCheckBoxBuilder<BackgroundType>
Make new Builder with an additional styler.

Returns
New Builder
Parameters
- styler: UIElementStyler<UILUTCheckBox<BackgroundType>>
  
  UiElementStyler for specific type
Returns UILUTCheckBoxBuilder<BackgroundType>

Inherited from UIElementBuilder.addStyler

setAlignment

setAlignment(alignment: "horizontal" | "vertical"): UILUTCheckBoxBuilder<BackgroundType>
Make new UILUTCheckBoxBuilder with different alignment.

Returns
New UILUTCheckBoxBuilder
Parameters
- alignment: "horizontal" | "vertical"
  
  Alignment for UILUTCheckBox
Returns UILUTCheckBoxBuilder<BackgroundType>

setBackground

setBackground<NewBackgroundType>(newBackground: BackgroundConstructor<NewBackgroundType>): UILUTCheckBoxBuilder<NewBackgroundType>
Make new UILUTCheckBoxBuilder with different background.
Type Parameters
- NewBackgroundType extends UIBackground<NewBackgroundType> & InternalBackground<NewBackgroundType>
Parameters
- newBackground: BackgroundConstructor<NewBackgroundType>
  
  Constructor for desired Background. See UIBackgrounds for a collection of options.
Returns UILUTCheckBoxBuilder<NewBackgroundType>

setButtonShape

setButtonShape(shape: Icon | PointShape): UILUTCheckBoxBuilder<BackgroundType>
Set button shape.

NOTE: It is recommended to use setButtonShape method instead, as it provides more flexibility (can be called during run-time after check box is created).
```
 // Example
 setButtonShape(PointShape.Star)
```
See PointShape for all available options.
Parameters
- shape: Icon | PointShape
Returns UILUTCheckBoxBuilder<BackgroundType>