Interface StylableButton

Interface for object that has configurations for style of button.

Hierarchy

StylableButton
- UICheckBox

Index

Methods

getButtonOffFillStyle getButtonOffSize getButtonOffStrokeStyle getButtonOnFillStyle getButtonOnSize getButtonOnStrokeStyle setButtonOffFillStyle setButtonOffSize setButtonOffStrokeStyle setButtonOnFillStyle setButtonOnSize setButtonOnStrokeStyle

Methods

getButtonOffFillStyle

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

Returns
Fill style object

Returns FillStyle

getButtonOffSize

getButtonOffSize(): Point
Get size of Button when state is OFF

Returns
Size of button as Point

Returns Point

getButtonOffStrokeStyle

getButtonOffStrokeStyle(): LineStyle
Get style of Button when state is OFF

Returns
Line style object

Returns LineStyle

getButtonOnFillStyle

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

Returns
Fill style object

Returns FillStyle

getButtonOnSize

getButtonOnSize(): Point
Get size of Button when state is ON

Returns
Size of button as Point

Returns Point

getButtonOnStrokeStyle

getButtonOnStrokeStyle(): LineStyle
Get style of Button when state is ON

Returns
Line style object

Returns LineStyle

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

setButtonOffSize

setButtonOffSize(size: number | Point): StylableButton
Set size of Button when state is OFF

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

setButtonOffStrokeStyle

setButtonOffStrokeStyle(value: LineStyle | ImmutableMutator<LineStyle, LineStyle>): StylableButton
Set style of Button when state is OFF

Returns
Object itself for fluent interface
Parameters
- value: LineStyle | ImmutableMutator<LineStyle, LineStyle>
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

setButtonOnSize

setButtonOnSize(size: number | Point): StylableButton
Set size of Button when state is ON

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

setButtonOnStrokeStyle

setButtonOnStrokeStyle(value: LineStyle | ImmutableMutator<LineStyle, LineStyle>): StylableButton
Set style of Button when state is ON

Returns
Object itself for fluent interface
Parameters
- value: LineStyle | ImmutableMutator<LineStyle, LineStyle>
Returns StylableButton