Interface UICheckBoxBuilder<BackgroundType>

Interface for 'CheckBox'-builder.

Type Parameters

BackgroundType extends UIBackground = UIBackground

Hierarchy

UIElementBuilder<UICheckBox<BackgroundType>>
- UICheckBoxBuilder

Index

Methods

addStyler setBackground setButtonShape

Methods

addStyler

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

Returns
New Builder
Parameters
- styler: UIElementStyler<UICheckBox<BackgroundType>>
  
  UiElementStyler for specific type
Returns UICheckBoxBuilder<BackgroundType>

Inherited from UIElementBuilder.addStyler

setBackground

setBackground<NewBackgroundType>(newBackground: BackgroundConstructor<NewBackgroundType>): UICheckBoxBuilder<NewBackgroundType>
Make new CheckBoxBuilder 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 UICheckBoxBuilder<NewBackgroundType>

setButtonShape

setButtonShape(shape: Icon | PointShape): UICheckBoxBuilder<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 UICheckBoxBuilder<BackgroundType>