102 lines
3.9 KiB
TypeScript
102 lines
3.9 KiB
TypeScript
import { TcHmiControl } from 'Beckhoff.TwinCAT.HMI.Framework/index.esm.js';
|
|
import type { Control as TcHmiLoadingSpinner } from '../TcHmiLoadingSpinner/TcHmiLoadingSpinner.esm.js';
|
|
declare class TcHmiIFrame extends TcHmiControl.Control {
|
|
#private;
|
|
constructor(element: JQuery, pcElement: JQuery, attrs: TcHmi.Controls.ControlAttributeList);
|
|
/** member variables */
|
|
/** Reference to the root dom element of the current control template as jquery object. */
|
|
protected __elementTemplateRoot: JQuery;
|
|
/** Reference to the underlying html iframe element as jquery object. */
|
|
protected __elementFrame: JQuery<HTMLIFrameElement>;
|
|
/** The Loading spinner control */
|
|
protected __loadingSpinner: TcHmiLoadingSpinner | undefined;
|
|
/** Localization Creator */
|
|
protected __localizedElements: Map<string, Element>;
|
|
protected __localizationReader: TcHmi.Locale.LocalizationReader | undefined;
|
|
/**
|
|
* Internal reference to the attribute "tchmi-src"
|
|
* Possible Values: Relative path to the target content file or url based on the project directory as root.
|
|
*/
|
|
protected __src: string | null | undefined;
|
|
/** Internal reference to the attribute 'data-tchmi-show-loading-spinner' */
|
|
protected __showLoadingSpinner: boolean | undefined;
|
|
protected __tchmiWithoutSplashScreen: boolean;
|
|
/**
|
|
* If raised, the control object exists in control cache and constructor of each inheritation level was called.
|
|
* This function is only to be used by the System. Other function calls are not intended.
|
|
*/
|
|
__previnit(): void;
|
|
/**
|
|
* If raised, all attributes have been set to it's default or dom values.
|
|
* This function is only to be used by the System. Other function calls are not intended.
|
|
*/
|
|
__init(): void;
|
|
/**
|
|
* Is called by the system after the control instance gets part of the current DOM.
|
|
* This function is only to be used by the System. Other function calls are not intended.
|
|
*/
|
|
__attach(): void;
|
|
/**
|
|
* Is called by the system after the control instance is no longer part of the current DOM.
|
|
* This function is only to be used by the System. Other function calls are not intended.
|
|
*/
|
|
__detach(): void;
|
|
/**
|
|
* Destroy the current control instance.
|
|
* Will be called automatically if system destroys control!
|
|
*/
|
|
destroy(): void;
|
|
/**
|
|
* Sets the src attribute to a new value.
|
|
* @param valueNew The new value for the src attribute;
|
|
*/
|
|
setSrc(valueNew: string | null): void;
|
|
/**
|
|
* @returns The current value of the src attribute.
|
|
*/
|
|
getSrc(): string | null | undefined;
|
|
/**
|
|
* Processes the current value of attribute src.
|
|
*/
|
|
protected __processSrc(): void;
|
|
/**
|
|
* Sets the value of showLoadingSpinner
|
|
* @param valueNew The new value for showLoadingSpinner
|
|
*/
|
|
setShowLoadingSpinner(valueNew: boolean | null): void;
|
|
/**
|
|
* Gets the value of showLoadingSpinner
|
|
* @returns The current value of showLoadingSpinner
|
|
*/
|
|
getShowLoadingSpinner(): boolean | undefined;
|
|
/**
|
|
* Processes showLoadingSpinner
|
|
*/
|
|
protected __processShowLoadingSpinner(): void;
|
|
/**
|
|
* Loads IFrame if access is now possible
|
|
*/
|
|
__processAccessConfig(): void;
|
|
/**
|
|
* Loads IFrame if access is now possible
|
|
*/
|
|
__processIsEnabled(): void;
|
|
/**
|
|
* Is raised if the load event is raised
|
|
*/
|
|
protected __onLoad(event: Event): void;
|
|
/**
|
|
* Is raised if the error event is raised
|
|
*/
|
|
protected __onError(event: ErrorEvent): void;
|
|
}
|
|
export { TcHmiIFrame as Control };
|
|
declare const _TcHmiIFrame: typeof TcHmiIFrame;
|
|
type tTcHmiIFrame = TcHmiIFrame;
|
|
declare global {
|
|
namespace TcHmi.Controls.Beckhoff {
|
|
const TcHmiIFrame: typeof _TcHmiIFrame;
|
|
type TcHmiIFrame = tTcHmiIFrame;
|
|
}
|
|
}
|
|
//# sourceMappingURL=TcHmiIFrame.esm.d.ts.map
|