Checkbox | kdayun 界面引擎API

label 复选框选择组件

Hierarchy

InputBase
- Checkbox

Index

Constructors

constructor

Properties

Constructors

constructor

new Checkbox(config: any): Checkbox

- Defined in YH-Standard/src/form/CheckBox.ts:106
Parameters
- config: any
Returns Checkbox

Properties

checkboxList

checkboxList: ICheckItem[]

复选配置项

css

css: CheckBoxStyle

itemDataSource

itemDataSource: string

数据项数据源

onCheckBoxScript

onCheckBoxScript: string

复选配置事件

theme

theme: checkboxStyle

复选框风格

titlefield

titlefield: string

数据标题显示字段

valuefield

valuefield: string

数据唯一值KEY字段

Methods

addCheckItem

addCheckItem(item: ICheckItem): void

- Defined in YH-Standard/src/form/CheckBox.ts:538
增加选项

Parameters
- item: ICheckItem
  
  新选项
Returns void

addClosebtn

addClosebtn(): JQuery<HTMLElement>

- Defined in YH-Standard/src/form/CheckBox.ts:120
Returns JQuery<HTMLElement>

Protected doDesigningDbClick

doDesigningDbClick(): void

- Defined in YH-Standard/src/form/CheckBox.ts:125
Returns void

Protected doGetClassName

doGetClassName(): string

- Defined in YH-Standard/src/form/CheckBox.ts:394
Returns string

doGetCss

doGetCss(): CheckBoxStyle

- Defined in YH-Standard/src/form/CheckBox.ts:189
Returns CheckBoxStyle

Protected doGetDefautlValue

doGetDefautlValue(): string[]

- Defined in YH-Standard/src/form/CheckBox.ts:449
Returns string[]

Protected doGetElemtHtml

doGetElemtHtml(): string

- Defined in YH-Standard/src/form/CheckBox.ts:397
Returns string

Protected doGetVerifyTipsElem

doGetVerifyTipsElem(): JQuery<HTMLElement>

- Defined in YH-Standard/src/form/CheckBox.ts:625
Returns JQuery<HTMLElement>

Protected doRenderCheckBox

doRenderCheckBox(): void

- Defined in YH-Standard/src/form/CheckBox.ts:565
Returns void

Protected doRenderCheckItemEnable

doRenderCheckItemEnable(item: ICheckItem): void

- Defined in YH-Standard/src/form/CheckBox.ts:505
Parameters
- item: ICheckItem
Returns void

Protected doRenderClickAmin

doRenderClickAmin(elem: JQuery<HTMLElement>): void

- Defined in YH-Standard/src/form/CheckBox.ts:559
Parameters
- elem: JQuery<HTMLElement>
Returns void

Protected doRenderEnable

doRenderEnable(): void

- Defined in YH-Standard/src/form/CheckBox.ts:499
Returns void

Protected doRenderInputValue

doRenderInputValue(): void

- Defined in YH-Standard/src/form/CheckBox.ts:475
Returns void

Protected doResetDsItems

doResetDsItems(): void

- Defined in YH-Standard/src/form/CheckBox.ts:365
根据数据源的行重设items

Returns void

getArrayValue

getArrayValue(): string[]

- Defined in YH-Standard/src/form/CheckBox.ts:523
得到勾选的值数组

Returns string[]

字符串数组

getAttrEditors

getAttrEditors(): AttributeEditorBase[]

- Defined in YH-Standard/src/form/CheckBox.ts:128
Returns AttributeEditorBase[]

getInputElem

getInputElem(): JQuery<HTMLElement>

- Defined in YH-Standard/src/form/CheckBox.ts:404
Returns JQuery<HTMLElement>

getInputName

getInputName(): string

- Defined in YH-Standard/src/form/CheckBox.ts:515
Returns string

getItemByVal

getItemByVal(val: string): number | ICheckItem | (() => string) | { (...items: ConcatArray<ICheckItem>[]): ICheckItem[]; (...items: (ICheckItem | ConcatArray<ICheckItem>)[]): ICheckItem[] } | ((searchElement: ICheckItem, fromIndex?: number) => number) | ((searchElement: ICheckItem, fromIndex?: number) => number) | ((start?: number, end?: number) => ICheckItem[]) | (() => string) | (() => ICheckItem) | ((...items: ICheckItem[]) => number) | ((separator?: string) => string) | (() => ICheckItem[]) | (() => ICheckItem) | ((compareFn?: (a: ICheckItem, b: ICheckItem) => number) => ICheckItem[]) | { (start: number, deleteCount?: number): ICheckItem[]; (start: number, deleteCount: number, ...items: ICheckItem[]): ICheckItem[] } | ((...items: ICheckItem[]) => number) | ((callbackfn: (value: ICheckItem, index: number, array: ICheckItem[]) => unknown, thisArg?: any) => boolean) | ((callbackfn: (value: ICheckItem, index: number, array: ICheckItem[]) => unknown, thisArg?: any) => boolean) | ((callbackfn: (value: ICheckItem, index: number, array: ICheckItem[]) => void, thisArg?: any) => void) | ((callbackfn: (value: ICheckItem, index: number, array: ICheckItem[]) => U, thisArg?: any) => U[]) | { <S>(callbackfn: (value: ICheckItem, index: number, array: ICheckItem[]) => value is S, thisArg?: any): S[]; (callbackfn: (value: ICheckItem, index: number, array: ICheckItem[]) => unknown, thisArg?: any): ICheckItem[] } | { (callbackfn: (previousValue: ICheckItem, currentValue: ICheckItem, currentIndex: number, array: ICheckItem[]) => ICheckItem): ICheckItem; (callbackfn: (previousValue: ICheckItem, currentValue: ICheckItem, currentIndex: number, array: ICheckItem[]) => ICheckItem, initialValue: ICheckItem): ICheckItem; (callbackfn: (previousValue: U, currentValue: ICheckItem, currentIndex: number, array: ICheckItem[]) => U, initialValue: U): U } | { (callbackfn: (previousValue: ICheckItem, currentValue: ICheckItem, currentIndex: number, array: ICheckItem[]) => ICheckItem): ICheckItem; (callbackfn: (previousValue: ICheckItem, currentValue: ICheckItem, currentIndex: number, array: ICheckItem[]) => ICheckItem, initialValue: ICheckItem): ICheckItem; (callbackfn: (previousValue: U, currentValue: ICheckItem, currentIndex: number, array: ICheckItem[]) => U, initialValue: U): U } | { <S>(predicate: (value: ICheckItem, index: number, obj: ICheckItem[]) => value is S, thisArg?: any): S; (predicate: (value: ICheckItem, index: number, obj: ICheckItem[]) => unknown, thisArg?: any): ICheckItem } | ((predicate: (value: ICheckItem, index: number, obj: ICheckItem[]) => unknown, thisArg?: any) => number) | ((value: ICheckItem, start?: number, end?: number) => ICheckItem[]) | ((target: number, start: number, end?: number) => ICheckItem[]) | (() => IterableIterator<[number, ICheckItem]>) | (() => IterableIterator<number>) | (() => IterableIterator<ICheckItem>)

- Defined in YH-Standard/src/form/CheckBox.ts:422
通过值返回item

Parameters
- val: string
 
 值
Returns number | ICheckItem | (() => string) | { (...items: ConcatArray<ICheckItem>[]): ICheckItem[]; (...items: (ICheckItem | ConcatArray<ICheckItem>)[]): ICheckItem[] } | ((searchElement: ICheckItem, fromIndex?: number) => number) | ((searchElement: ICheckItem, fromIndex?: number) => number) | ((start?: number, end?: number) => ICheckItem[]) | (() => string) | (() => ICheckItem) | ((...items: ICheckItem[]) => number) | ((separator?: string) => string) | (() => ICheckItem[]) | (() => ICheckItem) | ((compareFn?: (a: ICheckItem, b: ICheckItem) => number) => ICheckItem[]) | { (start: number, deleteCount?: number): ICheckItem[]; (start: number, deleteCount: number, ...items: ICheckItem[]): ICheckItem[] } | ((...items: ICheckItem[]) => number) | ((callbackfn: (value: ICheckItem, index: number, array: ICheckItem[]) => unknown, thisArg?: any) => boolean) | ((callbackfn: (value: ICheckItem, index: number, array: ICheckItem[]) => unknown, thisArg?: any) => boolean) | ((callbackfn: (value: ICheckItem, index: number, array: ICheckItem[]) => void, thisArg?: any) => void) | ((callbackfn: (value: ICheckItem, index: number, array: ICheckItem[]) => U, thisArg?: any) => U[]) | { <S>(callbackfn: (value: ICheckItem, index: number, array: ICheckItem[]) => value is S, thisArg?: any): S[]; (callbackfn: (value: ICheckItem, index: number, array: ICheckItem[]) => unknown, thisArg?: any): ICheckItem[] } | { (callbackfn: (previousValue: ICheckItem, currentValue: ICheckItem, currentIndex: number, array: ICheckItem[]) => ICheckItem): ICheckItem; (callbackfn: (previousValue: ICheckItem, currentValue: ICheckItem, currentIndex: number, array: ICheckItem[]) => ICheckItem, initialValue: ICheckItem): ICheckItem; (callbackfn: (previousValue: U, currentValue: ICheckItem, currentIndex: number, array: ICheckItem[]) => U, initialValue: U): U } | { (callbackfn: (previousValue: ICheckItem, currentValue: ICheckItem, currentIndex: number, array: ICheckItem[]) => ICheckItem): ICheckItem; (callbackfn: (previousValue: ICheckItem, currentValue: ICheckItem, currentIndex: number, array: ICheckItem[]) => ICheckItem, initialValue: ICheckItem): ICheckItem; (callbackfn: (previousValue: U, currentValue: ICheckItem, currentIndex: number, array: ICheckItem[]) => U, initialValue: U): U } | { <S>(predicate: (value: ICheckItem, index: number, obj: ICheckItem[]) => value is S, thisArg?: any): S; (predicate: (value: ICheckItem, index: number, obj: ICheckItem[]) => unknown, thisArg?: any): ICheckItem } | ((predicate: (value: ICheckItem, index: number, obj: ICheckItem[]) => unknown, thisArg?: any) => number) | ((value: ICheckItem, start?: number, end?: number) => ICheckItem[]) | ((target: number, start: number, end?: number) => ICheckItem[]) | (() => IterableIterator<[number, ICheckItem]>) | (() => IterableIterator<number>) | (() => IterableIterator<ICheckItem>)

返回item实例

getItemsDataSouce

getItemsDataSouce(): DataSourceBase

- Defined in YH-Standard/src/form/CheckBox.ts:345
得到组件的数据项数据源

Returns DataSourceBase

返回数据项的数据源实例

onValueChanged

onValueChanged(callback: onCheckedHandle): void

- Defined in YH-Standard/src/form/CheckBox.ts:621
值发生改变事件

Parameters
- callback: onCheckedHandle
  
  事件回调函数
Returns void

raiseOnCheckboxScript

raiseOnCheckboxScript(values: string[]): void

- Defined in YH-Standard/src/form/CheckBox.ts:609
执行界面编辑器设置的触发点击事件

Parameters
- values: string[]
  
  值数组
Returns void

removeCheckItem

removeCheckItem(v: string): void

- Defined in YH-Standard/src/form/CheckBox.ts:555
移除选项

Parameters
- v: string
  
  值
Returns void

render

render(): Checkbox

- Defined in YH-Standard/src/form/CheckBox.ts:491
渲染组件并触发事件

Returns Checkbox

Protected setCheckItemState

setCheckItemState(): void

- Defined in YH-Standard/src/form/CheckBox.ts:461
Returns void

setItemVisable

setItemVisable(item: ICheckItem, visiable: boolean): void

- Defined in YH-Standard/src/form/CheckBox.ts:413
设置item的是否可见

Parameters
- item: ICheckItem
  
  item 实例
- visiable: boolean
  
  true 可见,则反之
Returns void

setValue

setValue(value: string | string[]): void

- Defined in YH-Standard/src/form/CheckBox.ts:430
设置checkBox的值

Parameters
- value: string | string[]
  
  组件值,可以是字符串或者字符串数组
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: any

Returns Checkbox

Properties

checkboxList

css

itemDataSource

onCheckBoxScript

theme

titlefield

valuefield

Methods

addCheckItem

Parameters

item: ICheckItem

Returns void

addClosebtn

Returns JQuery<HTMLElement>

Protected doDesigningDbClick

Returns void

Protected doGetClassName

Returns string

doGetCss

Returns CheckBoxStyle

Protected doGetDefautlValue

Returns string[]

Protected doGetElemtHtml

Returns string

Protected doGetVerifyTipsElem

Returns JQuery<HTMLElement>

Protected doRenderCheckBox

Returns void

Protected doRenderCheckItemEnable

Parameters

item: ICheckItem

Returns void

Protected doRenderClickAmin

Parameters

elem: JQuery<HTMLElement>

Returns void

Protected doRenderEnable

Returns void

Protected doRenderInputValue

Returns void

Protected doResetDsItems

Returns void

getArrayValue

Returns string[]

getAttrEditors

Returns AttributeEditorBase[]

getInputElem

Returns JQuery<HTMLElement>

getInputName

Returns string

getItemByVal

Parameters

val: string

getItemsDataSouce

Returns DataSourceBase

onValueChanged

Parameters

callback: onCheckedHandle

Returns void

raiseOnCheckboxScript

Parameters

values: string[]

Returns void

removeCheckItem

Parameters

v: string

Returns void

render

Returns Checkbox