Reference Source
public class | source

Checkbox

Represents a ui checkbox

See:

Constructor Summary

Public Constructor
public

constructor(id: String, options: Object)

Constructor

Method Summary

Public Methods
public

checked(optional: Boolean): Null

gets or sets the status of the checkbox

public

enable(optional: Boolean): Null

gets or sets the status of the checkbox

public

name(optional: String): Null

gets or sets the name of the checkbox

public

value(optional: String): Null

gets or sets the value of the checkbox

Public Constructors

public constructor(id: String, options: Object) source

Constructor

Params:

NameTypeAttributeDescription
id String

checkbox id

options Object

config params

options.label Boolean

the label of the checkbox

options.name Boolean

the name of the checkbox

options.value Boolean

the value of the checkbox

options.enable Boolean

if true, the checkbox will be enable. otherwise, will be disabled.

options.checked Boolean

if true, the checkbox will be checked. otherwise, will be unchecked.

Public Methods

public checked(optional: Boolean): Null source

gets or sets the status of the checkbox

Params:

NameTypeAttributeDescription
optional Boolean

if true, the checkbox will be checked. otherwise, will be unchecked.

Return:

Null

public enable(optional: Boolean): Null source

gets or sets the status of the checkbox

Params:

NameTypeAttributeDescription
optional Boolean

if true, the checkbox will be enable. otherwise, will be disabled.

Return:

Null

public name(optional: String): Null source

gets or sets the name of the checkbox

Params:

NameTypeAttributeDescription
optional String

the name of checkbox

Return:

Null

public value(optional: String): Null source

gets or sets the value of the checkbox

Params:

NameTypeAttributeDescription
optional String

the value of checkbox

Return:

Null