tuain-ng-forms-lib
Version:
Componentes y Clases Angular para la gestión de formularios TUAIN
212 lines (211 loc) • 6.81 kB
TypeScript
import { Observable } from 'rxjs';
import { FormElement } from './element';
import { FieldDefinition, FieldEditionEvent, FieldCustomEventData, IFormConfig } from '../../interfaces/form-config.interface';
export interface DetailEvent {
code: string;
detail: any;
}
export interface FieldOption {
fieldOptionValue: string;
fieldOptionId: string;
}
export declare class FieldDescriptor extends FormElement {
private readonly _customEvent;
private readonly _editionFinish;
private readonly _editionPartial;
private readonly _detailRequest;
private _errorType;
private _errorCode;
private _errorMessage;
private _intrinsicErrorMessage;
private _minValue;
private _maxValue;
private _maxLength;
private _minLength;
private _focus;
private _onValidation;
private _validateOnServer;
private _value;
private _visibleLabel;
private _captureType;
private _defaultValue;
private _defaultEditable;
private _externalValue;
private _fieldAlignment;
private _fieldInfo;
private _fieldRequired;
private _fieldTitle;
private _fieldType;
private _fieldFormat;
private _hasChanged;
private _outputOnly;
private _tooltipText;
private _placeholder;
private _fieldCode;
private _fieldOptions;
private _customEmpty;
constructor(inputFieldReceived: FieldDefinition, formConfig: IFormConfig);
get alignment(): string;
set alignment(alignment: string);
get backend(): boolean;
get captureType(): string;
set captureType(captureType: string);
get placeholder(): string;
set placeholder(placeholder: string);
get code(): string;
get defaultValue(): any;
set defaultValue(defaultValue: any);
get defaultEditable(): boolean;
set defaultEditable(editable: boolean);
get detailRequest(): Observable<DetailEvent>;
get customEvent(): Observable<FieldCustomEventData>;
get editionFinish(): Observable<FieldEditionEvent>;
get editionPartial(): Observable<FieldEditionEvent>;
get empty(): boolean;
get error(): {
type: string;
code: string;
message: string;
};
set error(errorObj: {
type: string;
code: string;
message: string;
});
get errorCode(): string;
set errorCode(code: string);
get errorMessage(): string;
set errorMessage(msg: string);
get errorType(): string;
get externalValue(): any;
get format(): RegExp | null;
set format(format: RegExp | null);
get hasChanged(): boolean;
set hasChanged(hasChanged: boolean);
get info(): any;
set info(newInfo: string);
set intrinsicErrorMessage(message: string);
get maxLength(): string;
set maxLength(requiredMaxLength: any);
get maxValue(): any;
set maxValue(inputMaxValue: any);
get minLength(): number;
set minLength(requiredMinLength: number);
get minValue(): any;
set minValue(inputMinValue: any);
get name(): string;
get options(): FieldOption[] | null;
set options(newOptions: FieldOption[] | null);
get optionText(): string | null;
get outputOnly(): boolean;
set outputOnly(outputOnly: boolean);
get required(): boolean;
set required(required: boolean);
get title(): string;
set title(title: string);
get tooltip(): string;
set tooltip(tooltip: string);
get type(): string;
set type(fieldType: string);
get onValidation(): boolean;
get validating(): boolean;
set validating(isValidating: boolean);
get value(): any;
get validateOnServer(): boolean;
set validateOnServer(validateOnServer: boolean);
get serverAction(): boolean;
set serverAction(validateOnServer: boolean);
set value(newValue: any);
get visibleLabel(): boolean;
set visibleLabel(visibleLabel: boolean);
/**
* @deprecated Since v17. Use value instead. Will be removed in v19.
*/
get fieldValue(): any;
/**
* @deprecated Since v17. Use hasChanged instead. Will be removed in v19.
*/
changed(hasChanged?: boolean): void;
clean(): void;
setCustomEmpty(fn: ((this: FieldDescriptor) => boolean) | null): void;
focus(): void;
getErrorCode(): string;
setErrorCode(code: string): void;
getErrorMessage(): string;
setErrorMessage(msg: string): void;
getRequired(): boolean;
hasError(): boolean;
hideLabel(): void;
resetError(): void;
setEditable(editable?: boolean): void;
setValue(newValue: any, widgetUpdate?: boolean): void;
showLabel(): void;
/**
* @deprecated Since v17. Use code instead. Will be removed in v19.
*/
get fieldCode(): string;
/**
* @deprecated Since v17. Use title instead. Will be removed in v19.
*/
setLabel(label: string): void;
/**
* @deprecated Since v17. Use required instead. Will be removed in v19.
*/
setRequired(required: boolean): void;
/**
* @deprecated Since v17. Use changed instead. Will be removed in v19.
*/
setChanged(hasChanged: boolean): void;
/**
* @deprecated Since v17. Use value instead. Will be removed in v19.
*/
getValue(): any;
/**
* @deprecated Since v17. Use empty instead. Will be removed in v19.
*/
isEmpty(): boolean;
/**
* @deprecated Since v17. Use error instead. Will be removed in v19.
*/
getError(): {
type: string;
code: string;
message: string;
};
/**
* @deprecated Since v17. Use optionText instead. Will be removed in v19.
*/
getOptionText(): string;
/**
* @deprecated Since v17. Use options instead. Will be removed in v19.
*/
getFieldOptions(): FieldOption[];
/**
* @deprecated Since v17. Use options instead. Will be removed in v19.
*/
setFieldOptions(newOptions: any): any;
/**
* @deprecated Since v17. Use intrinsicErrorMessage instead. Will be removed in v19.
*/
setIntrinsicErrorMessage(message: string): void;
/**
* @deprecated Since v17. Use maxValue instead. Will be removed in v19.
*/
setMaxValue(inputMaxValue: any): void;
/**
* @deprecated Since v17. Use minValue instead. Will be removed in v19.
*/
setMinValue(inputMinValue: any): void;
/**
* @deprecated Since v17. Use showLabel instead. Will be removed in v19.
*/
setVisibleLabel(visibleLabel: boolean): void;
defaultEmpty(): boolean;
notifyEditionPartial(): void;
triggerCustomEvent(eventName: string, eventData: any): void;
notifyEditionFinish(): void;
notifyEditionDetailRequest(detail: any): void;
setError(code: string, message: string | null, type?: string): void;
updateFromServer(fld: any): void;
private _setValue;
}