ButtonComponentBuilder
in package
implements
ComponentBuilder
A builder class for button component.
Interfaces, Classes and Traits
- ComponentBuilder
- The interface that has a responsibility to build component.
Table of Contents
- $actionBuilder : TemplateActionBuilder
- $adjustMode : ComponentAdjustMode
- $color : string
- $component : array<string|int, mixed>|null
- $flex : int
- $gravity : ComponentGravity
- $height : ComponentButtonHeight
- $margin : ComponentMargin
- $offsetBottom : string
- $offsetEnd : string
- $offsetStart : string
- $offsetTop : string
- $position : string
- $style : ComponentButtonStyle
- __construct() : mixed
- ButtonComponentBuilder constructor.
- build() : array<string|int, mixed>
- Builds button component structure.
- builder() : ButtonComponentBuilder
- Create empty ButtonComponentBuilder.
- setAction() : ButtonComponentBuilder
- Set action.
- setAdjustMode() : $this
- Set adjustMode
- setColor() : ButtonComponentBuilder
- Set color.
- setFlex() : ButtonComponentBuilder
- Set flex.
- setGravity() : ButtonComponentBuilder
- Set gravity.
- setHeight() : ButtonComponentBuilder
- Set height.
- setMargin() : ButtonComponentBuilder
- Set margin.
- setOffsetBottom() : $this
- Set offsetBottom.
- setOffsetEnd() : $this
- Set offsetEnd.
- setOffsetStart() : $this
- Set offsetStart.
- setOffsetTop() : $this
- Set offsetTop.
- setPosition() : $this
- Set position.
- setStyle() : ButtonComponentBuilder
- Set style.
Properties
$actionBuilder
private
TemplateActionBuilder
$actionBuilder
$adjustMode
private
ComponentAdjustMode
$adjustMode
$color
private
string
$color
$component
private
array<string|int, mixed>|null
$component
$flex
private
int
$flex
$gravity
private
ComponentGravity
$gravity
$height
private
ComponentButtonHeight
$height
$margin
private
ComponentMargin
$margin
$offsetBottom
private
string
$offsetBottom
$offsetEnd
private
string
$offsetEnd
$offsetStart
private
string
$offsetStart
$offsetTop
private
string
$offsetTop
$position
private
string
$position
$style
private
ComponentButtonStyle
$style
Methods
__construct()
ButtonComponentBuilder constructor.
public
__construct(TemplateActionBuilder|null $actionBuilder[, int|null $flex = null ][, ComponentMargin|null $margin = null ][, ComponentButtonHeight|null $height = null ][, ComponentButtonStyle|null $style = null ][, string|null $color = null ][, ComponentGravity|null $gravity = null ]) : mixed
Parameters
- $actionBuilder : TemplateActionBuilder|null
- $flex : int|null = null
- $margin : ComponentMargin|null = null
- $height : ComponentButtonHeight|null = null
- $style : ComponentButtonStyle|null = null
- $color : string|null = null
- $gravity : ComponentGravity|null = null
Return values
mixed —build()
Builds button component structure.
public
build() : array<string|int, mixed>
Return values
array<string|int, mixed> —builder()
Create empty ButtonComponentBuilder.
public
static builder() : ButtonComponentBuilder
Return values
ButtonComponentBuilder —setAction()
Set action.
public
setAction(TemplateActionBuilder $actionBuilder) : ButtonComponentBuilder
Parameters
- $actionBuilder : TemplateActionBuilder
Return values
ButtonComponentBuilder —setAdjustMode()
Set adjustMode
public
setAdjustMode(ComponentAdjustMode|null $adjustMode) : $this
Parameters
- $adjustMode : ComponentAdjustMode|null
Return values
$this —setColor()
Set color.
public
setColor(string|null $color) : ButtonComponentBuilder
Parameters
- $color : string|null
Return values
ButtonComponentBuilder —setFlex()
Set flex.
public
setFlex(int|null $flex) : ButtonComponentBuilder
Parameters
- $flex : int|null
Return values
ButtonComponentBuilder —setGravity()
Set gravity.
public
setGravity(ComponentGravity|string|null $gravity) : ButtonComponentBuilder
Parameters
- $gravity : ComponentGravity|string|null
Return values
ButtonComponentBuilder —setHeight()
Set height.
public
setHeight(ComponentButtonHeight|string|null $height) : ButtonComponentBuilder
Parameters
- $height : ComponentButtonHeight|string|null
Return values
ButtonComponentBuilder —setMargin()
Set margin.
public
setMargin(ComponentMargin|string|null $margin) : ButtonComponentBuilder
Parameters
- $margin : ComponentMargin|string|null
Return values
ButtonComponentBuilder —setOffsetBottom()
Set offsetBottom.
public
setOffsetBottom(string|ComponentSpacing|null $offsetBottom) : $this
specifiable percentage, pixel and keyword. (e.g. percentage: 5% pixel: 5px keyword: none (defined in ComponentSpacing)
Parameters
- $offsetBottom : string|ComponentSpacing|null
Return values
$this —setOffsetEnd()
Set offsetEnd.
public
setOffsetEnd(string|ComponentSpacing|null $offsetEnd) : $this
specifiable percentage, pixel and keyword. (e.g. percentage: 5% pixel: 5px keyword: none (defined in ComponentSpacing)
Parameters
- $offsetEnd : string|ComponentSpacing|null
Return values
$this —setOffsetStart()
Set offsetStart.
public
setOffsetStart(string|ComponentSpacing|null $offsetStart) : $this
specifiable percentage, pixel and keyword. (e.g. percentage: 5% pixel: 5px keyword: none (defined in ComponentSpacing)
Parameters
- $offsetStart : string|ComponentSpacing|null
Return values
$this —setOffsetTop()
Set offsetTop.
public
setOffsetTop(string|ComponentSpacing|null $offsetTop) : $this
specifiable percentage, pixel and keyword. (e.g. percentage: 5% pixel: 5px keyword: none (defined in ComponentSpacing)
Parameters
- $offsetTop : string|ComponentSpacing|null
Return values
$this —setPosition()
Set position.
public
setPosition(string|ComponentPosition|null $position) : $this
specifiable relative or absolute
Parameters
- $position : string|ComponentPosition|null
Return values
$this —setStyle()
Set style.
public
setStyle(ComponentButtonStyle|string|null $style) : ButtonComponentBuilder
Parameters
- $style : ComponentButtonStyle|string|null