igniteui-angular-wrappers
Version:
A packaged version of Ignite UI wrappers for Angular
75 lines (74 loc) • 4.24 kB
TypeScript
import { ElementRef, IterableDiffers, KeyValueDiffers, ChangeDetectorRef, Renderer2 } from '@angular/core';
import { IgEditorBase } from './igeditorbase';
import { NgModel } from '@angular/forms';
import * as i0 from "@angular/core";
export declare class IgCheckboxEditorComponent extends IgEditorBase<IgCheckboxEditor> {
model: NgModel;
constructor(el: ElementRef, renderer: Renderer2, differs: IterableDiffers, kvalDiffers: KeyValueDiffers, cdr: ChangeDetectorRef, model: NgModel);
/**
* Checks if the value in the editor is valid. Note: This function will not trigger automatic notifications.
*/
isValid(): boolean;
/**
* Gets/Sets Current checked state/Value of the igCheckboxEditor that will be submitted by the HTML form.
* 1. If the [value](ui.igcheckboxeditor#options:value) option IS NOT defined,
* then 'value' method will match the checked state of the editor.
* This option is used when the checkbox is intended to operate as a Boolean editor. In that case the return type is bool.
* 2. If the [value](ui.igcheckboxeditor#options:value) option IS defined,
* then 'value' method will return the value that will be submitted when the editor is checked and the form is submitted.
* To get checked state regardless of the 'value' option, use $(".selector").igCheckboxEditor("option", "checked");
*
* @param newValue new value
*/
value(newValue: object): string;
/**
* Toggles the state of the checkbox.
*/
toggle(): void;
/**
* Gets/Sets name attribute applied to the editor element.
*
* @param newValue The new input name.
*/
inputName(newValue?: string): string;
/**
* Gets the input element of the editor.
*/
field(): string;
/**
* Gets a reference to the jQuery element that wraps the editor.
*/
editorContainer(): string;
/**
* Gets whether the editor has focus.
*/
hasFocus(): boolean;
/**
* Sets focus to the editor after the specified delay.
*
* @param delay The delay before focusing the editor.
*/
setFocus(delay?: number): void;
/**
* Hides the editor.
*/
hide(): void;
/**
* Shows the editor.
*/
show(): void;
/**
* Gets a reference to [igValidator](ui.igvalidator) used by the editor.
*/
validator(): object;
/**
* Triggers validation for the editor. If validatorOptions are set will also call validate on the [igValidator](ui.igvalidator).
*/
validate(): boolean;
/**
* Destroys the widget
*/
destroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<IgCheckboxEditorComponent, [null, null, null, null, null, { optional: true; }]>;
static ɵcmp: i0.ɵɵComponentDeclaration<IgCheckboxEditorComponent, "ig-checkbox-editor", never, { "widgetId": { "alias": "widgetId"; "required": false; }; "options": { "alias": "options"; "required": false; }; "changeDetectionInterval": { "alias": "changeDetectionInterval"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "create": { "alias": "create"; "required": false; }; "width": { "alias": "width"; "required": false; }; "height": { "alias": "height"; "required": false; }; "value": { "alias": "value"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; "allowNullValue": { "alias": "allowNullValue"; "required": false; }; "nullValue": { "alias": "nullValue"; "required": false; }; "inputName": { "alias": "inputName"; "required": false; }; "readOnly": { "alias": "readOnly"; "required": false; }; "validatorOptions": { "alias": "validatorOptions"; "required": false; }; "checked": { "alias": "checked"; "required": false; }; "size": { "alias": "size"; "required": false; }; "iconClass": { "alias": "iconClass"; "required": false; }; }, { "rendering": "rendering"; "rendered": "rendered"; "mousedown": "mousedown"; "mouseup": "mouseup"; "mousemove": "mousemove"; "mouseover": "mouseover"; "mouseout": "mouseout"; "blur": "blur"; "focus": "focus"; "keydown": "keydown"; "keypress": "keypress"; "keyup": "keyup"; "valueChanging": "valueChanging"; "valueChanged": "valueChanged"; }, never, ["*"], false, never>;
}