Class Checkbox

Hierarchy

Base
- Checkbox

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Checkbox(): Checkbox

Inherited from Base.constructor

Returns Checkbox

Properties

ctrlId

ctrlId: string

This is the actual name of the component

el

el: ExtElement

rendered

rendered: boolean

self

self: { TypeStr: string }

Type declaration

TypeStr: string

Static TypeStr

TypeStr: string

Methods

getCtrlPropValue

getCtrlPropValue(propertyName: string): any

Inherited from Base.getCtrlPropValue
- Defined in typings/cbn/ctrls.d.ts:69
Parameters
- propertyName: string
  
  One of Cbn.Enums.CtrlProperties
Returns any

getCtrlValue

getCtrlValue(): boolean

- Defined in typings/cbn/ctrls.d.ts:218
Returns boolean

getHeight

getHeight(): number

Inherited from Base.getHeight
- Defined in typings/cbn/ctrls.d.ts:22
Returns number

getInputEl

getInputEl(): undefined | ExtElement

- Defined in typings/cbn/ctrls.d.ts:229
Returns the input element of the control

Returns undefined | ExtElement

getSize

getSize(): { height: number; width: number }

Inherited from Base.getSize
- Defined in typings/cbn/ctrls.d.ts:21
Returns { height: number; width: number }
- height: number
- width: number

hasCls

hasCls(cls: string): boolean

Inherited from Base.hasCls
- Defined in typings/cbn/ctrls.d.ts:20
Parameters
- cls: string
Returns boolean

on

on(eventName: string, callback: Function, scope?: any, options?: object): void

Inherited from Base.on
- Defined in typings/cbn/ctrls.d.ts:13
This function is actually inherited from ExtJS: https://docs.sencha.com/extjs/6.2.0/modern/Ext.mixin.Observable.html#method-on

Parameters
- eventName: string
- callback: Function
- Optional scope: any
- Optional options: object
Returns void

setCheckboxValue

setCheckboxValue(value: boolean, silent?: boolean): void

- Defined in typings/cbn/ctrls.d.ts:224
Parameters
- value: boolean
- Optional silent: boolean
Returns void

setCtrlBckgr

setCtrlBckgr(value: string): void

Inherited from Base.setCtrlBckgr
- Defined in typings/cbn/ctrls.d.ts:47
Parameters
- value: string
  
  A css compliant background string
Returns void

setCtrlHeight

setCtrlHeight(value: string | number): void

Inherited from Base.setCtrlHeight
- Defined in typings/cbn/ctrls.d.ts:59
Parameters
- value: string | number
  
  CSS size string with or without unit or number which will be interpreted as px
Returns void

setCtrlVisibility

setCtrlVisibility(value: boolean | Show | Hide | PluggedOut, updateCtrlProperty?: boolean): void

Inherited from Base.setCtrlVisibility
- Defined in typings/cbn/ctrls.d.ts:42
Show or hide the control

Parameters
- value: boolean | Show | Hide | PluggedOut
  
  True: "Show"
  False: "PluggedOut"
- Optional updateCtrlProperty: boolean
Returns void

setCtrlWidth

setCtrlWidth(value: string): void

Inherited from Base.setCtrlWidth
- Defined in typings/cbn/ctrls.d.ts:54
Parameters
- value: string
  
  CSS size string with or without unit or number which will be interpreted as px
Returns void

setDisabled

setDisabled(value: boolean): void

Inherited from Base.setDisabled
- Defined in typings/cbn/ctrls.d.ts:49
Parameters
- value: boolean
Returns void

setUserCssClass

setUserCssClass(cls: string): void

Inherited from Base.setUserCssClass
- Defined in typings/cbn/ctrls.d.ts:64
Parameters
- cls: string
  
  One or more CSS classes which are added to the control. Previously added classes are removed.
Returns void

un

un(eventName: string, callback: Function, scope?: any): void

Inherited from Base.un
- Defined in typings/cbn/ctrls.d.ts:18
This function is actually inherited from ExtJS: https://docs.sencha.com/extjs/6.2.0/modern/Ext.mixin.Observable.html#method-un

Parameters
- eventName: string
- callback: Function
- Optional scope: any
Returns void

Generated using TypeDoc