368 lines
15 KiB
TypeScript
368 lines
15 KiB
TypeScript
// Compatibility file for non-module typescript compiles without adjustments.
|
|
// Use the following line for modern code (needs adjustments to tsconfig.json#configOptions/paths)
|
|
// import { TcHmiControl } from "Beckhoff.TwinCAT.HMI.Framework/index.esm.js";
|
|
// ***************************************************************************
|
|
|
|
declare class TcHmiRadioButton extends TcHmi.Controls.System.TcHmiControl {
|
|
#private;
|
|
constructor(element: JQuery, pcElement: JQuery, attrs: TcHmi.Controls.ControlAttributeList);
|
|
protected __elementTemplateRoot: JQuery;
|
|
protected __textNode: Text | null;
|
|
protected __radioGroup: string | null | undefined;
|
|
protected __radioState: TcHmi.ToggleState | undefined;
|
|
protected __stateSymbol: TcHmi.Symbol<boolean> | null | undefined;
|
|
/**
|
|
* Used to determine if this.__stateSymbol has ben initially read at least once before a write is processed to the symbol.
|
|
* Because the state symbol state has a higher priority than internal or configured state.
|
|
*/
|
|
protected __stateSymbolInitialized: boolean;
|
|
protected __radioStateIconColor: TcHmi.SolidColor | null | undefined;
|
|
protected __radioStateBackgroundColor: TcHmi.SolidColor | null | undefined;
|
|
protected __text: string | null | undefined;
|
|
/** Internal reference to the attribute "data-tchmi-ignore-escape-sequences" */
|
|
protected __ignoreEscapeSequences: boolean | undefined;
|
|
protected __textPosition: TextPosition | undefined;
|
|
protected __textHorizontalAlignment: TcHmi.HorizontalAlignment | undefined;
|
|
protected __textVerticalAlignment: TcHmi.VerticalAlignment | undefined;
|
|
protected __textFontFamily: TcHmi.FontFamily | null | undefined;
|
|
protected __textFontSize: number | null | undefined;
|
|
protected __textFontSizeUnit: TcHmi.FontSizeUnit | undefined;
|
|
protected __textFontStyle: TcHmi.FontStyle | undefined;
|
|
protected __textFontWeight: TcHmi.FontWeight | undefined;
|
|
protected __textColor: TcHmi.SolidColor | null | undefined;
|
|
/**
|
|
* ReadOnly state of the control.
|
|
*/
|
|
protected __isReadOnly: boolean | undefined;
|
|
/** Destroy functions */
|
|
protected __onRadioGroupToggledEventDestroyEvent: TcHmi.DestroyFunction | null;
|
|
protected __destroyStateSymbolWatch: TcHmi.DestroyFunction | null;
|
|
/** Helper */
|
|
protected __state: boolean;
|
|
protected __isActive: 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;
|
|
/**
|
|
* Is raised when the onPressed event is fired from the base control.
|
|
*/
|
|
protected __onPressed(): void;
|
|
/**
|
|
* Is raised when the onResized event is fired from the base control.
|
|
*/
|
|
protected __onResized(): void;
|
|
/**
|
|
* Is raised if a member of 'radioGroup' has raised the toggled event.
|
|
*/
|
|
protected __onRadioGroupToggled(event: TcHmi.EventProvider.Event, data: {
|
|
activeElementId: string;
|
|
source: string;
|
|
}): void;
|
|
/**
|
|
* Sets the radioGroup attribute to a new value.
|
|
* @param valueNew The new value for the radioGroup attribute.
|
|
*/
|
|
setRadioGroup(valueNew: string | null): void;
|
|
/**
|
|
* Returns the current value of the radioGroup attribute
|
|
*/
|
|
getRadioGroup(): string | null | undefined;
|
|
/**
|
|
* Processes the current value of the radioGroup attribute.
|
|
*/
|
|
protected __processRadioGroup(): void;
|
|
/**
|
|
* Sets the radioState attribute to a new value.
|
|
* @param valueNew The new value for the radioState attribute.
|
|
* @param forwardStateSymbol Does nothing, only exists for backwards compatibility purposes.
|
|
* @param process Allows to disable underlying calls to processRadioState. Required if a StateSymbol change is forwarded to the RadioState.
|
|
*/
|
|
protected __setRadioState(valueNew: TcHmi.ToggleState | null, forwardStateSymbol: boolean, process: boolean): void;
|
|
/**
|
|
* Sets the radioState attribute to a new value.
|
|
* @param valueNew The new value for the radioState attribute.
|
|
*/
|
|
setRadioState(valueNew: TcHmi.ToggleState | null): void;
|
|
/**
|
|
* Returns the current value of the radioState attribute
|
|
*/
|
|
getRadioState(): TcHmi.ToggleState | undefined;
|
|
/**
|
|
* Processes the current value of the radioState attribute.
|
|
* @param forwardStateSymbol Does nothing, only exists for backwards compatibility purposes.
|
|
*/
|
|
protected __processRadioState(forwardStateSymbol?: boolean): void;
|
|
/**
|
|
* Sets the stateSymbol attribute to a new value.
|
|
* @param valueNew The new value for stateSymbol.
|
|
*/
|
|
setStateSymbol(valueNew: TcHmi.Symbol | null): void;
|
|
protected __processStateSymbolResult(data: TcHmi.Symbol.IReadResultObject<boolean>): void;
|
|
/**
|
|
* The watch callback for the StateSymbol.
|
|
* @param data Object containing the new value of the StateSymbol.
|
|
*/
|
|
protected __onStateSymbolWatch(data: TcHmi.Symbol.IReadResultObject<boolean>): void;
|
|
/**
|
|
* Returns the current value of the stateSymbol attribute.
|
|
*/
|
|
getStateSymbol(): TcHmi.Symbol<boolean> | null | undefined;
|
|
/**
|
|
* Writes the given state to the state symbol, if it exists. Otherwise just sets the internal state variable.
|
|
* @param state The state to write.
|
|
* @param source What caused the state change. Could be 'userInteraction', the change of an 'attribute' or the state symbol, or the 'toggleGroup'.
|
|
*/
|
|
protected __writeState(state: boolean, source: string): Promise<boolean>;
|
|
/**
|
|
* Sets the internal state variable and raises state change events if state has changed.
|
|
* @param state The new state of the control.
|
|
* @param source What caused the state change. Could be 'userInteraction', the change of an 'attribute' or the state symbol, or the 'toggleGroup'.
|
|
*/
|
|
protected __setInternalState(state: boolean, source: string): void;
|
|
/**
|
|
* Writes the state symbol, or just sets the internal state variable, depending on the value of forwardStateSymbol.
|
|
* @param state The new state.
|
|
* @param forwardStateSymbol Whether to write the state symbol or just set the internal state variable.
|
|
* @param source What caused the state change. Could be 'userInteraction', the change of an 'attribute' or the state symbol, or the 'toggleGroup'.
|
|
*/
|
|
protected __processState(state: boolean, forwardStateSymbol: boolean, source: string): void;
|
|
/**
|
|
* Sets whether the checkbox should be displayed in an active state.
|
|
* @param valueNew The new active state.
|
|
*/
|
|
protected __setIsActive(valueNew: boolean): void;
|
|
/**
|
|
* Sets the text color and calls the associated process function (processRadioStateIconColor).
|
|
* @param valueNew The new value for radioStateIconColor.
|
|
*/
|
|
setRadioStateIconColor(valueNew: TcHmi.SolidColor | null): void;
|
|
/**
|
|
* The watch callback for the radioStateIconColor object resolver.
|
|
* @param data Object containing the new value for radioStateIconColor
|
|
*/
|
|
protected __onResolverForRadioStateIconColorWatchCallback(data: TcHmi.Symbol.ObjectResolver.IWatchResultObject<TcHmi.SolidColor>): void;
|
|
/**
|
|
* Returns the current value of radioStateIconColor.
|
|
* @returns The current value of radioStateIconColor.
|
|
*/
|
|
getRadioStateIconColor(): TcHmi.SolidColor | null | undefined;
|
|
/**
|
|
* Processes the current radioStateIconColor attribute value.
|
|
*/
|
|
protected __processRadioStateIconColor(): void;
|
|
/**
|
|
* Sets the text color and calls the associated process function (processRadioStateBackgroundColor).
|
|
* @param valueNew The new value for radioStateBackgroundColor.
|
|
*/
|
|
setRadioStateBackgroundColor(valueNew: TcHmi.SolidColor | null): void;
|
|
/**
|
|
* The watch callback for the radioStateBackgroundColor object resolver.
|
|
* @param data Object containing the new value for radioStateBackgroundColor
|
|
*/
|
|
protected __onResolverForRadioStateBackgroundColorWatchCallback(data: TcHmi.Symbol.ObjectResolver.IWatchResultObject<TcHmi.SolidColor>): void;
|
|
/**
|
|
* Returns the current value of radioStateBackgroundColor.
|
|
* @returns The current value of radioStateBackgroundColor.
|
|
*/
|
|
getRadioStateBackgroundColor(): TcHmi.SolidColor | null | undefined;
|
|
/**
|
|
* Processes the current radioStateIconColor attribute value.
|
|
*/
|
|
protected __processRadioStateBackgroundColor(): void;
|
|
/**
|
|
* Sets the text attribute to a new value.
|
|
* @param valueNew The new value for the text attribute.
|
|
*/
|
|
setText(valueNew: string | null): void;
|
|
/**
|
|
* Returns the current value of the text attribute
|
|
*/
|
|
getText(): string | null | undefined;
|
|
/**
|
|
* Processes the current value of the text attribute.
|
|
*/
|
|
protected __processText(): void;
|
|
/**
|
|
* Sets the value of the member variable IgnoreEscapeSequences.
|
|
* @param valueNew The new value for IgnoreEscapeSequences
|
|
*/
|
|
setIgnoreEscapeSequences(valueNew: boolean | null | undefined): void;
|
|
/**
|
|
* Returns the current value of IgnoreEscapeSequences.
|
|
* @returns The current value of IgnoreEscapeSequences.
|
|
*/
|
|
getIgnoreEscapeSequences(): boolean | undefined;
|
|
/**
|
|
* Sets the textPosition attribute to a new value.
|
|
* @param valueNew The new value for the textPosition attribute.
|
|
*/
|
|
setTextPosition(valueNew: TextPosition | null): void;
|
|
/**
|
|
* Returns the current value of the textPosition attribute
|
|
*/
|
|
getTextPosition(): TextPosition | undefined;
|
|
/**
|
|
* Processes the current value of the textPosition attribute.
|
|
*/
|
|
protected __processTextPosition(): void;
|
|
/**
|
|
* Sets the textHorizontalAlignment attribute to a new value.
|
|
* @param valueNew The new value for the textHorizontalAlignment attribute.
|
|
*/
|
|
setTextHorizontalAlignment(valueNew: TcHmi.HorizontalAlignment | null): void;
|
|
/**
|
|
* Returns the current value of the textHorizontalAlignment attribute
|
|
*/
|
|
getTextHorizontalAlignment(): TcHmi.HorizontalAlignment | undefined;
|
|
/**
|
|
* Processes the current value of the textHorizontalAlignment attribute.
|
|
*/
|
|
protected __processTextHorizontalAlignment(): void;
|
|
/**
|
|
* Sets the textVerticalAlignment attribute to a new value.
|
|
* @param valueNew The new value for the textVerticalAlignment attribute.
|
|
*/
|
|
setTextVerticalAlignment(valueNew: TcHmi.VerticalAlignment | null): void;
|
|
/**
|
|
* Returns the current value of the textVerticalAlignment attribute
|
|
*/
|
|
getTextVerticalAlignment(): TcHmi.VerticalAlignment | undefined;
|
|
/**
|
|
* Processes the current value of the textVerticalAlignment attribute.
|
|
*/
|
|
protected __processTextVerticalAlignment(): void;
|
|
/**
|
|
* Sets the textFontFamily attribute to a new value.
|
|
* @param valueNew The new value for the textFontFamily attribute.
|
|
*/
|
|
setTextFontFamily(valueNew: TcHmi.FontFamily | null): void;
|
|
/**
|
|
* Returns the current value of the textFontFamily attribute
|
|
*/
|
|
getTextFontFamily(): string | null | undefined;
|
|
/**
|
|
* Processes the current value of the textFontFamily attribute.
|
|
*/
|
|
protected __processTextFontFamily(): void;
|
|
/**
|
|
* Sets the textFontSize attribute to a new value.
|
|
* @param valueNew The new value for the textFontSize attribute.
|
|
*/
|
|
setTextFontSize(valueNew: number | null): void;
|
|
/**
|
|
* Returns the current value of the textFontSize attribute
|
|
*/
|
|
getTextFontSize(): number | null | undefined;
|
|
/**
|
|
* Processes the current value of the textFontSize attribute.
|
|
*/
|
|
protected __processTextFontSize(): void;
|
|
/**
|
|
* Sets the textFontSizeUnit attribute to a new value.
|
|
* @param valueNew The new value for the textFontSizeUnit attribute.
|
|
*/
|
|
setTextFontSizeUnit(valueNew: TcHmi.FontSizeUnit | null): void;
|
|
/**
|
|
* Returns the current value of the textFontSizeUnit attribute
|
|
*/
|
|
getTextFontSizeUnit(): TcHmi.FontSizeUnit | undefined;
|
|
/**
|
|
* Processes the current value of the textFontSizeUnit attribute.
|
|
*/
|
|
protected __processTextFontSizeUnit(): void;
|
|
/**
|
|
* Sets the textFontStyle attribute to a new value.
|
|
* @param valueNew The new value for the textFontStyle attribute.
|
|
*/
|
|
setTextFontStyle(valueNew: TcHmi.FontStyle | null): void;
|
|
/**
|
|
* Returns the current value of the textFontStyle attribute
|
|
*/
|
|
getTextFontStyle(): TcHmi.FontStyle | undefined;
|
|
/**
|
|
* Processes the current value of the textFontStyle attribute.
|
|
*/
|
|
protected __processTextFontStyle(): void;
|
|
/**
|
|
* Sets the textFontWeight attribute to a new value.
|
|
* @param valueNew The new value for the textFontWeight attribute.
|
|
*/
|
|
setTextFontWeight(valueNew: TcHmi.FontWeight | null): void;
|
|
/**
|
|
* Returns the current value of the textFontWeight attribute
|
|
*/
|
|
getTextFontWeight(): TcHmi.FontWeight | undefined;
|
|
/**
|
|
* Processes the current value of the textFontWeight attribute.
|
|
*/
|
|
protected __processTextFontWeight(): void;
|
|
/**
|
|
* Sets the text color and calls the associated process function (processTextColor).
|
|
* @param valueNew The new value for textColor.
|
|
*/
|
|
setTextColor(valueNew: TcHmi.SolidColor | null): void;
|
|
/**
|
|
* The watch callback for the textColor object resolver.
|
|
* @param data Object containing the new value for textColor
|
|
*/
|
|
protected __onResolverForTextColorWatchCallback(data: TcHmi.Symbol.ObjectResolver.IWatchResultObject<TcHmi.SolidColor>): void;
|
|
/**
|
|
* Returns the current value of textColor.
|
|
* @returns The current value of textColor.
|
|
*/
|
|
getTextColor(): TcHmi.SolidColor | null | undefined;
|
|
/**
|
|
* Processes the current textColor attribute value.
|
|
*/
|
|
protected __processTextColor(): void;
|
|
/**
|
|
* Sets the isReadOnly attribute and calls the associated process function (processIsReadOnly).
|
|
* @preserve (Part of the public API)
|
|
*/
|
|
setIsReadOnly(valueNew: boolean | null): void;
|
|
/**
|
|
* Returns the effective value of isReadOnly based on own and parent isReadOnly variable.
|
|
*/
|
|
getIsReadOnly(): boolean | undefined;
|
|
/**
|
|
* Process IsReadOnly.
|
|
*/
|
|
protected __processIsReadOnly(): void;
|
|
}
|
|
export type TextPosition = 'Left' | 'Right';
|
|
export { TcHmiRadioButton as Control };
|
|
declare const _TcHmiRadioButton: typeof TcHmiRadioButton;
|
|
type tTcHmiRadioButton = TcHmiRadioButton;
|
|
type tTextPosition = TextPosition;
|
|
declare global {
|
|
namespace TcHmi.Controls.Beckhoff {
|
|
const TcHmiRadioButton: typeof _TcHmiRadioButton;
|
|
type TcHmiRadioButton = tTcHmiRadioButton;
|
|
namespace TcHmiRadioButton {
|
|
type TextPosition = tTextPosition;
|
|
}
|
|
}
|
|
}
|