Interface StylableButton

Interface for object that has configurations for style of button.

Hierarchy

StylableButton
- UICheckBox

Index

Methods

getButtonOffFillStyle getButtonOnFillStyle getButtonShape getButtonSize setButtonOffFillStyle setButtonOnFillStyle setButtonShape setButtonSize

Methods

getButtonOffFillStyle

getButtonOffFillStyle(): FillStyle
Get fill style of Button when state is OFF

Returns
Fill style object

Returns FillStyle

getButtonOnFillStyle

getButtonOnFillStyle(): FillStyle
Get fill style of Button when state is ON

Returns
Fill style object

Returns FillStyle

getButtonShape

getButtonShape(): Icon | PointShape
Get button shape.

Returns Icon | PointShape

getButtonSize

getButtonSize(): Point
Get size of Button

Returns
Size of button as Point

Returns Point

setButtonOffFillStyle

setButtonOffFillStyle(value: FillStyle | ImmutableMutator<FillStyle, FillStyle>): StylableButton
Set fill style of Button when state is OFF

Returns
Object itself for fluent interface
Parameters
- value: FillStyle | ImmutableMutator<FillStyle, FillStyle>
  
  Fill style object or function which modifies it
Returns StylableButton

setButtonOnFillStyle

setButtonOnFillStyle(value: FillStyle | Mutator<FillStyle>): StylableButton
Set fill style of Button when state is ON

Returns
Object itself for fluent interface
Parameters
- value: FillStyle | Mutator<FillStyle>
  
  Fill style object or function which modifies it
Returns StylableButton

setButtonShape

setButtonShape(shape: Icon | PointShape): StylableButton
Set button shape.
```
 // Example
 setButtonShape(PointShape.Star)
```
See PointShape for all available options.
Parameters
- shape: Icon | PointShape
Returns StylableButton

setButtonSize

setButtonSize(size: number | Point): StylableButton
Set size of Button

Returns
Object itself
Parameters
- size: number | Point
  
  Point or pixel for squared button size
Returns StylableButton