\FML\ComponentsCheckBoxDesign

Class representing CheckBox Design

Summary

Methods
Properties
Constants
defaultDesign()
__construct()
getStyle()
setStyle()
getSubStyle()
setSubStyle()
setStyles()
getImageUrl()
setImageUrl()
applyToQuad()
getDesignString()
No public properties found
No constants found
No protected methods found
$style
$subStyle
$imageUrl
N/A
No private methods found
No private properties found
N/A

Properties

$style

$style : string

Type

string — Style name

$subStyle

$subStyle : string

Type

string — SubStyle name

$imageUrl

$imageUrl : string

Type

string — Image url

Methods

defaultDesign()

defaultDesign() : static

Create the default Design

Returns

static

__construct()

__construct(string  $style = null, string  $subStyle = null) 

Construct a new CheckBox Design

Parameters

string $style

(optional) Style name or image url

string $subStyle

(optional) SubStyle name

getStyle()

getStyle() : string

Get the style

Returns

string

setStyle()

setStyle(string  $style) : static

Set the style

Parameters

string $style

Style name

Returns

static

getSubStyle()

getSubStyle() : string

Get the sub style

Returns

string

setSubStyle()

setSubStyle(string  $subStyle) : static

Set the sub style

Parameters

string $subStyle

SubStyle name

Returns

static

setStyles()

setStyles(string  $style, string  $subStyle) : static

Set the style and the sub style

Parameters

string $style

Style name

string $subStyle

SubStyle name

Returns

static

getImageUrl()

getImageUrl() : string

Get the image url

Returns

string

setImageUrl()

setImageUrl(string  $imageUrl) : static

Set the image url

Parameters

string $imageUrl

Image url

Returns

static

applyToQuad()

applyToQuad(\FML\Controls\Quad  $quad) : static

Apply the Design to the given Quad

Parameters

\FML\Controls\Quad $quad

CheckBox Quad

Returns

static

getDesignString()

getDesignString() : string

Get the CheckBox Design string

Returns

string