@smart-webcomponents-angular/window 22.0.3 → 24.0.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm2020/window/smart.window.mjs +136 -106
- package/fesm2015/smart-webcomponents-angular-window.mjs +135 -105
- package/fesm2015/smart-webcomponents-angular-window.mjs.map +1 -1
- package/fesm2020/smart-webcomponents-angular-window.mjs +135 -105
- package/fesm2020/smart-webcomponents-angular-window.mjs.map +1 -1
- package/index.d.ts +5489 -5228
- package/package.json +1 -1
- package/source/modules/smart.window.js +1 -1
- package/source/smart.button.js +1 -1
- package/source/smart.combobox.js +2 -2
- package/source/smart.dropdownlist.js +2 -2
- package/source/smart.element.js +2 -2
- package/source/smart.listbox.js +2 -2
- package/source/smart.multilinetextbox.js +1 -1
- package/source/smart.progressbar.js +1 -1
- package/source/smart.scrollbar.js +1 -1
- package/source/smart.textbox.js +1 -1
- package/source/smart.window.js +2 -2
- package/styles/smart.base.css +1 -1
- package/styles/smart.window.css +2 -2
- package/window/smart.window.d.ts +110 -105
|
@@ -120,43 +120,43 @@ class WindowComponent extends BaseElement {
|
|
|
120
120
|
constructor(ref) {
|
|
121
121
|
super(ref);
|
|
122
122
|
this.eventHandlers = [];
|
|
123
|
-
/** @description This event is triggered
|
|
123
|
+
/** @description This event is triggered immediately before the window begins its opening process, allowing developers to perform any preparatory actions or modifications prior to the window becoming visible to the user.
|
|
124
124
|
* @param event. The custom event. */
|
|
125
125
|
this.onOpening = new EventEmitter();
|
|
126
|
-
/** @description This event is triggered when the window is opened
|
|
126
|
+
/** @description This event is triggered when the window becomes visible to the user—specifically, when it is opened or brought into view.
|
|
127
127
|
* @param event. The custom event. */
|
|
128
128
|
this.onOpen = new EventEmitter();
|
|
129
|
-
/** @description This event is triggered
|
|
129
|
+
/** @description This event is triggered immediately before the window begins the closing process, allowing developers to execute custom logic or prompt the user for confirmation before the window is fully closed.
|
|
130
130
|
* @param event. The custom event. */
|
|
131
131
|
this.onClosing = new EventEmitter();
|
|
132
|
-
/** @description This event is triggered when the window is closed
|
|
132
|
+
/** @description This event is triggered when the window is closed or becomes hidden, such as when the user closes the browser tab, navigates away, or minimizes the window, causing it to no longer be visible to the user.
|
|
133
133
|
* @param event. The custom event. */
|
|
134
134
|
this.onClose = new EventEmitter();
|
|
135
|
-
/** @description This event is triggered
|
|
135
|
+
/** @description This event is triggered whenever the application window is minimized or collapsed by the user. It allows you to execute custom logic in response to the window being hidden from view.
|
|
136
136
|
* @param event. The custom event. */
|
|
137
137
|
this.onCollapse = new EventEmitter();
|
|
138
|
-
/** @description This event is triggered when
|
|
138
|
+
/** @description This event is triggered when the user finishes dragging the window, signaling the completion of the drag-and-drop operation. It occurs after the mouse button is released and the window movement has stopped.
|
|
139
139
|
* @param event. The custom event. */
|
|
140
140
|
this.onDragEnd = new EventEmitter();
|
|
141
|
-
/** @description This event is triggered when window
|
|
141
|
+
/** @description This event is triggered when the user initiates a window drag operation, indicating that the dragging of the window has begun. It fires as soon as the user starts moving the window, typically by clicking and holding the window's title bar.
|
|
142
142
|
* @param event. The custom event. */
|
|
143
143
|
this.onDragStart = new EventEmitter();
|
|
144
|
-
/** @description This event is triggered
|
|
144
|
+
/** @description This event is triggered whenever the window is resized to a larger size, indicating that the user has expanded the window either by dragging its edges or by maximizing it.
|
|
145
145
|
* @param event. The custom event. */
|
|
146
146
|
this.onExpand = new EventEmitter();
|
|
147
|
-
/** @description This event is triggered
|
|
147
|
+
/** @description This event is triggered whenever the application window transitions into a maximized state. It fires immediately after the window expands to fill the available screen space, allowing developers to implement custom logic in response to the window being maximized by the user or programmatically.
|
|
148
148
|
* @param event. The custom event. */
|
|
149
149
|
this.onMaximize = new EventEmitter();
|
|
150
|
-
/** @description This event is triggered
|
|
150
|
+
/** @description This event is triggered whenever the application window is minimized by the user. It occurs immediately after the minimize action takes place, allowing developers to execute custom logic—such as pausing background processes, saving state, or updating the UI—in response to the window being minimized.
|
|
151
151
|
* @param event. The custom event. */
|
|
152
152
|
this.onMinimize = new EventEmitter();
|
|
153
|
-
/** @description This event is triggered when window
|
|
153
|
+
/** @description This event is triggered when the user completes resizing the browser window, specifically after the resizing action has finished and the window size is no longer changing.
|
|
154
154
|
* @param event. The custom event. */
|
|
155
155
|
this.onResizeEnd = new EventEmitter();
|
|
156
|
-
/** @description This event is triggered when window
|
|
156
|
+
/** @description This event is triggered when the user initiates a window resize action, such as clicking and dragging the window’s edge or corner to change its dimensions. It marks the beginning of the window resizing process, allowing you to execute scripts or handle UI updates as soon as resizing starts.
|
|
157
157
|
* @param event. The custom event. */
|
|
158
158
|
this.onResizeStart = new EventEmitter();
|
|
159
|
-
/** @description This event is triggered when the window is
|
|
159
|
+
/** @description This event is triggered when the window is returned to its original size and position after being maximized, effectively restoring it to the state it was in prior to maximization.
|
|
160
160
|
* @param event. The custom event. */
|
|
161
161
|
this.onRestore = new EventEmitter();
|
|
162
162
|
this.nativeElement = ref.nativeElement;
|
|
@@ -171,497 +171,497 @@ class WindowComponent extends BaseElement {
|
|
|
171
171
|
}
|
|
172
172
|
return this.nativeElement;
|
|
173
173
|
}
|
|
174
|
-
/** @description Determines
|
|
174
|
+
/** @description Determines whether the 'Add New' tab within the Tabs element is currently visible to the user. Note: This property is only relevant when used with the TabsWindow component; it does not apply to other components. */
|
|
175
175
|
get addNewTab() {
|
|
176
176
|
return this.nativeElement ? this.nativeElement.addNewTab : undefined;
|
|
177
177
|
}
|
|
178
178
|
set addNewTab(value) {
|
|
179
179
|
this.nativeElement ? this.nativeElement.addNewTab = value : undefined;
|
|
180
180
|
}
|
|
181
|
-
/** @description Sets or
|
|
181
|
+
/** @description Sets or retrieves the current animation mode. When this property is set to 'none', all animations are disabled. If set to any other supported value, animations will be enabled and behave according to the specified mode. */
|
|
182
182
|
get animation() {
|
|
183
183
|
return this.nativeElement ? this.nativeElement.animation : undefined;
|
|
184
184
|
}
|
|
185
185
|
set animation(value) {
|
|
186
186
|
this.nativeElement ? this.nativeElement.animation = value : undefined;
|
|
187
187
|
}
|
|
188
|
-
/** @description
|
|
188
|
+
/** @description Controls the automatic capitalization behavior for user input as it is entered or edited. This setting specifies whether characters are auto-capitalized (e.g., sentences, words, or all characters) in the input field. Note: This property is only relevant when used with the MultilinePromptWindow component. */
|
|
189
189
|
get autoCapitalize() {
|
|
190
190
|
return this.nativeElement ? this.nativeElement.autoCapitalize : undefined;
|
|
191
191
|
}
|
|
192
192
|
set autoCapitalize(value) {
|
|
193
193
|
this.nativeElement ? this.nativeElement.autoCapitalize = value : undefined;
|
|
194
194
|
}
|
|
195
|
-
/** @description
|
|
195
|
+
/** @description Specifies whether the element should automatically expand its height to accommodate vertically overflowing input. Note: This setting only applies to MultilinePromptWindow components. */
|
|
196
196
|
get autoExpand() {
|
|
197
197
|
return this.nativeElement ? this.nativeElement.autoExpand : undefined;
|
|
198
198
|
}
|
|
199
199
|
set autoExpand(value) {
|
|
200
200
|
this.nativeElement ? this.nativeElement.autoExpand = value : undefined;
|
|
201
201
|
}
|
|
202
|
-
/** @description
|
|
202
|
+
/** @description Specifies the text displayed on the 'Cancel' button within the Prompt Window. This label informs users which button will dismiss or close the prompt without taking any action. */
|
|
203
203
|
get cancelLabel() {
|
|
204
204
|
return this.nativeElement ? this.nativeElement.cancelLabel : undefined;
|
|
205
205
|
}
|
|
206
206
|
set cancelLabel(value) {
|
|
207
207
|
this.nativeElement ? this.nativeElement.cancelLabel = value : undefined;
|
|
208
208
|
}
|
|
209
|
-
/** @description
|
|
209
|
+
/** @description Specifies the text that appears on the 'Complete' button within the Progress Window, allowing customization of the button label to better suit user interface requirements. */
|
|
210
210
|
get completeLabel() {
|
|
211
211
|
return this.nativeElement ? this.nativeElement.completeLabel : undefined;
|
|
212
212
|
}
|
|
213
213
|
set completeLabel(value) {
|
|
214
214
|
this.nativeElement ? this.nativeElement.completeLabel = value : undefined;
|
|
215
215
|
}
|
|
216
|
-
/** @description
|
|
216
|
+
/** @description Specifies the text displayed on the 'Confirm' button within the Prompt Window, allowing customization of the button label to suit your application's context. */
|
|
217
217
|
get confirmLabel() {
|
|
218
218
|
return this.nativeElement ? this.nativeElement.confirmLabel : undefined;
|
|
219
219
|
}
|
|
220
220
|
set confirmLabel(value) {
|
|
221
221
|
this.nativeElement ? this.nativeElement.confirmLabel = value : undefined;
|
|
222
222
|
}
|
|
223
|
-
/** @description
|
|
223
|
+
/** @description Indicates whether the window is currently collapsed. When set to true, only the window's header is displayed while the content area is hidden. If false, both the header and the full content of the window are visible. */
|
|
224
224
|
get collapsed() {
|
|
225
225
|
return this.nativeElement ? this.nativeElement.collapsed : undefined;
|
|
226
226
|
}
|
|
227
227
|
set collapsed(value) {
|
|
228
228
|
this.nativeElement ? this.nativeElement.collapsed = value : undefined;
|
|
229
229
|
}
|
|
230
|
-
/** @description When a modal window is opened,
|
|
230
|
+
/** @description When a modal window is opened, this property specifies whether clicking on the overlay (mask) outside the modal will close the window. Set it to true to allow users to dismiss the modal by clicking the mask, or false to require an explicit action (such as clicking a close button) to close the modal. */
|
|
231
231
|
get closeOnMaskClick() {
|
|
232
232
|
return this.nativeElement ? this.nativeElement.closeOnMaskClick : undefined;
|
|
233
233
|
}
|
|
234
234
|
set closeOnMaskClick(value) {
|
|
235
235
|
this.nativeElement ? this.nativeElement.closeOnMaskClick = value : undefined;
|
|
236
236
|
}
|
|
237
|
-
/** @description
|
|
237
|
+
/** @description Specifies the data source to be loaded into the TabsWindow component. This property is relevant exclusively for the TabsWindow and will not affect other components. */
|
|
238
238
|
get dataSource() {
|
|
239
239
|
return this.nativeElement ? this.nativeElement.dataSource : undefined;
|
|
240
240
|
}
|
|
241
241
|
set dataSource(value) {
|
|
242
242
|
this.nativeElement ? this.nativeElement.dataSource = value : undefined;
|
|
243
243
|
}
|
|
244
|
-
/** @description
|
|
244
|
+
/** @description Controls whether the window is active and visible to the user. When enabled, the window is operational and can be interacted with; when disabled, the window is hidden or inactive, and user interactions are ignored. */
|
|
245
245
|
get disabled() {
|
|
246
246
|
return this.nativeElement ? this.nativeElement.disabled : undefined;
|
|
247
247
|
}
|
|
248
248
|
set disabled(value) {
|
|
249
249
|
this.nativeElement ? this.nativeElement.disabled = value : undefined;
|
|
250
250
|
}
|
|
251
|
-
/** @description
|
|
251
|
+
/** @description Controls whether the window snapping feature is active. When enabled, users can automatically align and resize windows by dragging them to the edges or corners of the screen. Disabling this feature prevents windows from snapping into place during movement. */
|
|
252
252
|
get disableSnap() {
|
|
253
253
|
return this.nativeElement ? this.nativeElement.disableSnap : undefined;
|
|
254
254
|
}
|
|
255
255
|
set disableSnap(value) {
|
|
256
256
|
this.nativeElement ? this.nativeElement.disableSnap = value : undefined;
|
|
257
257
|
}
|
|
258
|
-
/** @description By default the window
|
|
258
|
+
/** @description By default, pressing the 'Escape' key will automatically close the window. To prevent the window from closing when 'Escape' is pressed, set this property to true. */
|
|
259
259
|
get disableEscape() {
|
|
260
260
|
return this.nativeElement ? this.nativeElement.disableEscape : undefined;
|
|
261
261
|
}
|
|
262
262
|
set disableEscape(value) {
|
|
263
263
|
this.nativeElement ? this.nativeElement.disableEscape = value : undefined;
|
|
264
264
|
}
|
|
265
|
-
/** @description By default the window
|
|
265
|
+
/** @description By default, the window handles certain keyboard inputs such as the arrow keys ('ArrowUp', 'ArrowDown', etc.), 'Escape', and similar keys for scrolling or navigation actions. Set this property to true to disable the window’s default keyboard handling, allowing you to manage these key events manually within your application. */
|
|
266
266
|
get disableKeyboard() {
|
|
267
267
|
return this.nativeElement ? this.nativeElement.disableKeyboard : undefined;
|
|
268
268
|
}
|
|
269
269
|
set disableKeyboard(value) {
|
|
270
270
|
this.nativeElement ? this.nativeElement.disableKeyboard = value : undefined;
|
|
271
271
|
}
|
|
272
|
-
/** @description
|
|
272
|
+
/** @description Specifies the visual presentation of characters entered within the input field. For example, this setting can control whether characters are shown as plain text or masked (such as for password fields). This option applies specifically to the Prompt Window component. */
|
|
273
273
|
get displayMode() {
|
|
274
274
|
return this.nativeElement ? this.nativeElement.displayMode : undefined;
|
|
275
275
|
}
|
|
276
276
|
set displayMode(value) {
|
|
277
277
|
this.nativeElement ? this.nativeElement.displayMode = value : undefined;
|
|
278
278
|
}
|
|
279
|
-
/** @description Applicable to TabsWindow when docked
|
|
279
|
+
/** @description ''Applicable to TabsWindow components when they are docked within a DockingLayout Custom Element.This property specifies the valid drop locations for the window—and its tab items—inside the DockingLayout. The property accepts an array of positional values, allowing you to define multiple allowable drop zones.Details: Positions prefixed with 'layout-' apply to each individual tab item (child element) of the TabsWindow being dragged. These determine where tab items can be dropped within the overall layout, outside their original container. Other position values (without the 'layout-' prefix) indicate allowed drop positions directly within the hovered target TabsWindow, specifying where the whole window or its tabs can be placed relative to the target window.Notes: This property is used exclusively by jqxDockingLayout custom elements. It controls the possible drop targets—both at the window and tab levels—within the DockingLayout environment.Allowed Values: The array values specify the permitted drop positions. Refer to the documentation for a complete list of supported position strings. */
|
|
280
280
|
get dropPosition() {
|
|
281
281
|
return this.nativeElement ? this.nativeElement.dropPosition : undefined;
|
|
282
282
|
}
|
|
283
283
|
set dropPosition(value) {
|
|
284
284
|
this.nativeElement ? this.nativeElement.dropPosition = value : undefined;
|
|
285
285
|
}
|
|
286
|
-
/** @description A callback function
|
|
286
|
+
/** @description A callback function that specifies how to format the label displayed on the Progress Bar. This function allows customization of the label's content or appearance based on the current progress value. Note: This property is only applicable to the ProgressWindow component. */
|
|
287
287
|
get formatFunction() {
|
|
288
288
|
return this.nativeElement ? this.nativeElement.formatFunction : undefined;
|
|
289
289
|
}
|
|
290
290
|
set formatFunction(value) {
|
|
291
291
|
this.nativeElement ? this.nativeElement.formatFunction = value : undefined;
|
|
292
292
|
}
|
|
293
|
-
/** @description
|
|
293
|
+
/** @description Specifies the exact placement or alignment of the footer section within the window element, such as positioning it at the bottom, fixed, absolute, or relative to other content. This property controls where the footer appears in relation to the window’s layout. */
|
|
294
294
|
get footerPosition() {
|
|
295
295
|
return this.nativeElement ? this.nativeElement.footerPosition : undefined;
|
|
296
296
|
}
|
|
297
297
|
set footerPosition(value) {
|
|
298
298
|
this.nativeElement ? this.nativeElement.footerPosition = value : undefined;
|
|
299
299
|
}
|
|
300
|
-
/** @description
|
|
300
|
+
/** @description Specifies the custom template used to render the footer section of the Dialog window. If footerTemplate is set to null (the default), the Dialog will not display a footer section. You can provide a template string or a function to customize the appearance and content of the Dialog’s footer. */
|
|
301
301
|
get footerTemplate() {
|
|
302
302
|
return this.nativeElement ? this.nativeElement.footerTemplate : undefined;
|
|
303
303
|
}
|
|
304
304
|
set footerTemplate(value) {
|
|
305
305
|
this.nativeElement ? this.nativeElement.footerTemplate = value : undefined;
|
|
306
306
|
}
|
|
307
|
-
/** @description
|
|
307
|
+
/** @description Specifies which buttons will be displayed in the header section, allowing you to control the visibility of header actions for users. */
|
|
308
308
|
get headerButtons() {
|
|
309
309
|
return this.nativeElement ? this.nativeElement.headerButtons : undefined;
|
|
310
310
|
}
|
|
311
311
|
set headerButtons(value) {
|
|
312
312
|
this.nativeElement ? this.nativeElement.headerButtons = value : undefined;
|
|
313
313
|
}
|
|
314
|
-
/** @description
|
|
314
|
+
/** @description Specifies the custom template to be used for rendering the header section of the dialog window. If headerTemplate is set to null (the default value), the dialog will display its standard header layout. By providing a template, you can fully customize the appearance and content of the dialog's header area. */
|
|
315
315
|
get headerTemplate() {
|
|
316
316
|
return this.nativeElement ? this.nativeElement.headerTemplate : undefined;
|
|
317
317
|
}
|
|
318
318
|
set headerTemplate(value) {
|
|
319
319
|
this.nativeElement ? this.nativeElement.headerTemplate = value : undefined;
|
|
320
320
|
}
|
|
321
|
-
/** @description
|
|
321
|
+
/** @description Specifies the exact placement of the header section within the window element, such as top, bottom, left, or right. This setting controls where the header appears relative to the content of the window. */
|
|
322
322
|
get headerPosition() {
|
|
323
323
|
return this.nativeElement ? this.nativeElement.headerPosition : undefined;
|
|
324
324
|
}
|
|
325
325
|
set headerPosition(value) {
|
|
326
326
|
this.nativeElement ? this.nativeElement.headerPosition = value : undefined;
|
|
327
327
|
}
|
|
328
|
-
/** @description
|
|
328
|
+
/** @description Displays supplementary helper text beneath the text box, providing users with additional guidance or context. This hint appears only when the text box is focused (i.e., the user is actively typing or has selected the field). Note: This property is specifically applicable to the Prompt Window component. */
|
|
329
329
|
get hint() {
|
|
330
330
|
return this.nativeElement ? this.nativeElement.hint : undefined;
|
|
331
331
|
}
|
|
332
332
|
set hint(value) {
|
|
333
333
|
this.nativeElement ? this.nativeElement.hint = value : undefined;
|
|
334
334
|
}
|
|
335
|
-
/** @description Sets the
|
|
335
|
+
/** @description Sets the Progress bar value to the indeterminate state ('null'), activating its loading animation to indicate ongoing progress without a defined endpoint. Note: This property is only applicable when used within a ProgressWindow component. */
|
|
336
336
|
get indeterminate() {
|
|
337
337
|
return this.nativeElement ? this.nativeElement.indeterminate : undefined;
|
|
338
338
|
}
|
|
339
339
|
set indeterminate(value) {
|
|
340
340
|
this.nativeElement ? this.nativeElement.indeterminate = value : undefined;
|
|
341
341
|
}
|
|
342
|
-
/** @description
|
|
342
|
+
/** @description Specifies the direction in which the Progress Bar fills (e.g., left-to-right, right-to-left, top-to-bottom, or bottom-to-top). Note: This property is only applicable when used within a ProgressWindow component. */
|
|
343
343
|
get inverted() {
|
|
344
344
|
return this.nativeElement ? this.nativeElement.inverted : undefined;
|
|
345
345
|
}
|
|
346
346
|
set inverted(value) {
|
|
347
347
|
this.nativeElement ? this.nativeElement.inverted = value : undefined;
|
|
348
348
|
}
|
|
349
|
-
/** @description
|
|
349
|
+
/** @description Specifies the text displayed as the window title in the header section, typically shown at the top of the application window or dialog box. */
|
|
350
350
|
get label() {
|
|
351
351
|
return this.nativeElement ? this.nativeElement.label : undefined;
|
|
352
352
|
}
|
|
353
353
|
set label(value) {
|
|
354
354
|
this.nativeElement ? this.nativeElement.label = value : undefined;
|
|
355
355
|
}
|
|
356
|
-
/** @description When enabled the resizing operation
|
|
356
|
+
/** @description When enabled, the resizing operation updates the element’s size in real time as the user drags its edges, providing immediate visual feedback. By default, this feature is disabled; instead, a highlighter appears around the edges of the window during resizing to indicate the prospective new size, while the element itself resizes only once the operation is complete. */
|
|
357
357
|
get liveResize() {
|
|
358
358
|
return this.nativeElement ? this.nativeElement.liveResize : undefined;
|
|
359
359
|
}
|
|
360
360
|
set liveResize(value) {
|
|
361
361
|
this.nativeElement ? this.nativeElement.liveResize = value : undefined;
|
|
362
362
|
}
|
|
363
|
-
/** @description
|
|
363
|
+
/** @description Note: This property is relevant only for TabsWindow elements that are utilized within a DockingLayout custom element.This property is exclusively used by jqxDockingLayout to specify ownership of a TabsWindow. It determines which jqxDockingLayout instance the window is associated with. If a TabsWindow is removed from its parent DockingLayout element, this property continues to reference the original docking layout to which it belonged.The property accepts either: A string representing the id of a jqxDockingLayout present on the page. An instance of a jqxDockingLayout object.This allows for flexible identification of the owning layout, either by ID or by direct reference to the layout instance. */
|
|
364
364
|
get layout() {
|
|
365
365
|
return this.nativeElement ? this.nativeElement.layout : undefined;
|
|
366
366
|
}
|
|
367
367
|
set layout(value) {
|
|
368
368
|
this.nativeElement ? this.nativeElement.layout = value : undefined;
|
|
369
369
|
}
|
|
370
|
-
/** @description
|
|
370
|
+
/** @description Gets or sets the unlockKey, a unique code required to activate or unlock access to the product’s full features or licensed functionality. */
|
|
371
371
|
get unlockKey() {
|
|
372
372
|
return this.nativeElement ? this.nativeElement.unlockKey : undefined;
|
|
373
373
|
}
|
|
374
374
|
set unlockKey(value) {
|
|
375
375
|
this.nativeElement ? this.nativeElement.unlockKey = value : undefined;
|
|
376
376
|
}
|
|
377
|
-
/** @description
|
|
377
|
+
/** @description Specifies the language to be used for displaying messages. This property can be set or retrieved, and works in conjunction with the messages property to determine which set of localized messages is shown to the user. Changing the language updates the displayed messages accordingly. */
|
|
378
378
|
get locale() {
|
|
379
379
|
return this.nativeElement ? this.nativeElement.locale : undefined;
|
|
380
380
|
}
|
|
381
381
|
set locale(value) {
|
|
382
382
|
this.nativeElement ? this.nativeElement.locale = value : undefined;
|
|
383
383
|
}
|
|
384
|
-
/** @description
|
|
384
|
+
/** @description Note: This property is only applicable to a TabsWindow when it is docked within a DockingLayout custom element. When enabled, it controls whether the TabsWindow can be resized by the user. If set to true, users will be able to adjust the size of the TabsWindow within the DockingLayout; if set to false, resizing will be disabled and the TabsWindow will have a fixed size. */
|
|
385
385
|
get locked() {
|
|
386
386
|
return this.nativeElement ? this.nativeElement.locked : undefined;
|
|
387
387
|
}
|
|
388
388
|
set locked(value) {
|
|
389
389
|
this.nativeElement ? this.nativeElement.locked = value : undefined;
|
|
390
390
|
}
|
|
391
|
-
/** @description Callback,
|
|
391
|
+
/** @description Callback function used within the localization module, typically invoked when a localization event occurs (e.g., language change, resource load). This callback handles tasks such as updating UI elements or retrieving localized content based on the current language settings. */
|
|
392
392
|
get localizeFormatFunction() {
|
|
393
393
|
return this.nativeElement ? this.nativeElement.localizeFormatFunction : undefined;
|
|
394
394
|
}
|
|
395
395
|
set localizeFormatFunction(value) {
|
|
396
396
|
this.nativeElement ? this.nativeElement.localizeFormatFunction = value : undefined;
|
|
397
397
|
}
|
|
398
|
-
/** @description
|
|
398
|
+
/** @description Indicates whether the window is currently maximized. When set to true, the window expands to fill the entire available viewport, covering all other interface elements and leaving no visible borders or title bars. If false, the window retains its previous size and position. This property can be used to programmatically check or control the window’s maximized state within the application. */
|
|
399
399
|
get maximized() {
|
|
400
400
|
return this.nativeElement ? this.nativeElement.maximized : undefined;
|
|
401
401
|
}
|
|
402
402
|
set maximized(value) {
|
|
403
403
|
this.nativeElement ? this.nativeElement.maximized = value : undefined;
|
|
404
404
|
}
|
|
405
|
-
/** @description
|
|
405
|
+
/** @description Defines or retrieves an object containing localized strings used throughout the widget’s user interface. This property allows developers to customize the widget’s displayed text for different languages and regions. It is typically used together with the locale property to ensure that the widget adapts its content based on the selected language or regional settings. */
|
|
406
406
|
get messages() {
|
|
407
407
|
return this.nativeElement ? this.nativeElement.messages : undefined;
|
|
408
408
|
}
|
|
409
409
|
set messages(value) {
|
|
410
410
|
this.nativeElement ? this.nativeElement.messages = value : undefined;
|
|
411
411
|
}
|
|
412
|
-
/** @description
|
|
412
|
+
/** @description Specifies whether the window should function as a modal dialog. When set to true, the window captures user focus and prevents interaction with any other elements on the page until it is closed. This ensures that the user must address or dismiss the modal window before returning to the rest of the content. */
|
|
413
413
|
get modal() {
|
|
414
414
|
return this.nativeElement ? this.nativeElement.modal : undefined;
|
|
415
415
|
}
|
|
416
416
|
set modal(value) {
|
|
417
417
|
this.nativeElement ? this.nativeElement.modal = value : undefined;
|
|
418
418
|
}
|
|
419
|
-
/** @description
|
|
419
|
+
/** @description For use with TabsWindow when docked within a DockingLayout custom element: Specifies the maximum size that the TabsWindow component can occupy when it is docked. For the ProgressWindow component: Defines the maximum value for the progress bar, allowing users to set the upper limit of the ProgressBar's range. */
|
|
420
420
|
get max() {
|
|
421
421
|
return this.nativeElement ? this.nativeElement.max : undefined;
|
|
422
422
|
}
|
|
423
423
|
set max(value) {
|
|
424
424
|
this.nativeElement ? this.nativeElement.max = value : undefined;
|
|
425
425
|
}
|
|
426
|
-
/** @description Applicable to TabsWindow when docked inside DockingLayout
|
|
426
|
+
/** @description Applicable to TabsWindow when docked inside a DockingLayout custom element. Specifies the minimum allowed size for the item within the layout, ensuring it does not shrink below this value during resizing operations.Also applies to ProgressWindow, where it lets the user set the minimum value for the ProgressBar, defining the lowest possible progress state that can be represented. */
|
|
427
427
|
get min() {
|
|
428
428
|
return this.nativeElement ? this.nativeElement.min : undefined;
|
|
429
429
|
}
|
|
430
430
|
set min(value) {
|
|
431
431
|
this.nativeElement ? this.nativeElement.min = value : undefined;
|
|
432
432
|
}
|
|
433
|
-
/** @description
|
|
433
|
+
/** @description Indicates whether the window is currently minimized. When set to true, the window is reduced to an icon or compact form and positioned (docked) in the bottom left corner of the viewport. If false, the window remains in its normal, active state. */
|
|
434
434
|
get minimized() {
|
|
435
435
|
return this.nativeElement ? this.nativeElement.minimized : undefined;
|
|
436
436
|
}
|
|
437
437
|
set minimized(value) {
|
|
438
438
|
this.nativeElement ? this.nativeElement.minimized = value : undefined;
|
|
439
439
|
}
|
|
440
|
-
/** @description
|
|
440
|
+
/** @description Specifies or retrieves the maximum number of characters a user is allowed to enter into the input field. This property applies to both Prompt and MultilinePrompt windows. If set, the input will be limited to the defined character count, preventing users from entering more characters than specified. */
|
|
441
441
|
get maxLength() {
|
|
442
442
|
return this.nativeElement ? this.nativeElement.maxLength : undefined;
|
|
443
443
|
}
|
|
444
444
|
set maxLength(value) {
|
|
445
445
|
this.nativeElement ? this.nativeElement.maxLength = value : undefined;
|
|
446
446
|
}
|
|
447
|
-
/** @description
|
|
447
|
+
/** @description Defines the minimum number of characters a user must enter before the autocomplete feature is activated. This property can be both set (to specify the desired threshold) and retrieved (to check the current threshold). Note: This setting is only applicable to Prompt and MultilinePrompt windows. */
|
|
448
448
|
get minLength() {
|
|
449
449
|
return this.nativeElement ? this.nativeElement.minLength : undefined;
|
|
450
450
|
}
|
|
451
451
|
set minLength(value) {
|
|
452
452
|
this.nativeElement ? this.nativeElement.minLength = value : undefined;
|
|
453
453
|
}
|
|
454
|
-
/** @description
|
|
454
|
+
/** @description Indicates whether the window is currently visible to the user. Returns true if the window is displayed on the screen and can be interacted with, and false if it is hidden or minimized. */
|
|
455
455
|
get opened() {
|
|
456
456
|
return this.nativeElement ? this.nativeElement.opened : undefined;
|
|
457
457
|
}
|
|
458
458
|
set opened(value) {
|
|
459
459
|
this.nativeElement ? this.nativeElement.opened = value : undefined;
|
|
460
460
|
}
|
|
461
|
-
/** @description
|
|
461
|
+
/** @description Indicates whether the window is pinned. A pinned window cannot be moved (dragged) by the user, but it can still be resized. When set to true, this property disables window dragging while allowing resizing operations. */
|
|
462
462
|
get pinned() {
|
|
463
463
|
return this.nativeElement ? this.nativeElement.pinned : undefined;
|
|
464
464
|
}
|
|
465
465
|
set pinned(value) {
|
|
466
466
|
this.nativeElement ? this.nativeElement.pinned = value : undefined;
|
|
467
467
|
}
|
|
468
|
-
/** @description
|
|
468
|
+
/** @description Specifies the placeholder text that appears inside the input field before the user enters a value. Note: This option is only applicable to the Prompt Window component. */
|
|
469
469
|
get placeholder() {
|
|
470
470
|
return this.nativeElement ? this.nativeElement.placeholder : undefined;
|
|
471
471
|
}
|
|
472
472
|
set placeholder(value) {
|
|
473
473
|
this.nativeElement ? this.nativeElement.placeholder = value : undefined;
|
|
474
474
|
}
|
|
475
|
-
/** @description
|
|
475
|
+
/** @description Specifies the text label displayed above or alongside the input field within the PromptWindow component. This label helps users understand what information is expected in the input field. */
|
|
476
476
|
get promptLabel() {
|
|
477
477
|
return this.nativeElement ? this.nativeElement.promptLabel : undefined;
|
|
478
478
|
}
|
|
479
479
|
set promptLabel(value) {
|
|
480
480
|
this.nativeElement ? this.nativeElement.promptLabel = value : undefined;
|
|
481
481
|
}
|
|
482
|
-
/** @description If the element
|
|
482
|
+
/** @description If the element has the "readonly" attribute, users cannot modify its value; the field will display data in a non-editable state, though users can still select and copy its contents. This differs from a "disabled" element, as a "readonly" field remains focusable and included in form submissions. */
|
|
483
483
|
get readonly() {
|
|
484
484
|
return this.nativeElement ? this.nativeElement.readonly : undefined;
|
|
485
485
|
}
|
|
486
486
|
set readonly(value) {
|
|
487
487
|
this.nativeElement ? this.nativeElement.readonly = value : undefined;
|
|
488
488
|
}
|
|
489
|
-
/** @description When
|
|
489
|
+
/** @description When this option is enabled, a resize handle appears in the bottom-right corner of the window. Users can initiate the resizing operation exclusively by dragging this indicator; resizing from any other window edge or corner is disabled. */
|
|
490
490
|
get resizeIndicator() {
|
|
491
491
|
return this.nativeElement ? this.nativeElement.resizeIndicator : undefined;
|
|
492
492
|
}
|
|
493
493
|
set resizeIndicator(value) {
|
|
494
494
|
this.nativeElement ? this.nativeElement.resizeIndicator = value : undefined;
|
|
495
495
|
}
|
|
496
|
-
/** @description
|
|
496
|
+
/** @description Specifies how the window can be resized by the user.Available resizing modes: none – Disables all window resizing; the window size is fixed. vertical – Allows the window to be resized only vertically (top and bottom edges). horizontal – Allows the window to be resized only horizontally (left and right edges). both – Enables both horizontal and vertical resizing; the window can be resized in any direction. top – The window can only be resized by dragging the top edge. bottom – The window can only be resized by dragging the bottom edge. left – The window can only be resized by dragging the left edge. right – The window can only be resized by dragging the right edge.Choose the desired mode to control which edges of the window users can drag to resize, or to prevent resizing entirely. */
|
|
497
497
|
get resizeMode() {
|
|
498
498
|
return this.nativeElement ? this.nativeElement.resizeMode : undefined;
|
|
499
499
|
}
|
|
500
500
|
set resizeMode(value) {
|
|
501
501
|
this.nativeElement ? this.nativeElement.resizeMode = value : undefined;
|
|
502
502
|
}
|
|
503
|
-
/** @description
|
|
503
|
+
/** @description Gets or sets a value that determines whether the element’s alignment is configured to support right-to-left (RTL) languages and text direction, such as Arabic or Hebrew. Use this property to ensure proper display and alignment for locales that require RTL font and layout support. */
|
|
504
504
|
get rightToLeft() {
|
|
505
505
|
return this.nativeElement ? this.nativeElement.rightToLeft : undefined;
|
|
506
506
|
}
|
|
507
507
|
set rightToLeft(value) {
|
|
508
508
|
this.nativeElement ? this.nativeElement.rightToLeft = value : undefined;
|
|
509
509
|
}
|
|
510
|
-
/** @description
|
|
510
|
+
/** @description Indicates that the input field is required and must be filled out by the user before the form can be submitted. If left empty, the form submission will be blocked, prompting the user to complete this field. 'Note:' This setting is applicable to the Prompt Window. */
|
|
511
511
|
get required() {
|
|
512
512
|
return this.nativeElement ? this.nativeElement.required : undefined;
|
|
513
513
|
}
|
|
514
514
|
set required(value) {
|
|
515
515
|
this.nativeElement ? this.nativeElement.required = value : undefined;
|
|
516
516
|
}
|
|
517
|
-
/** @description
|
|
517
|
+
/** @description Defines the error message displayed when the required attribute is enabled and the user submits the input field without providing a value. This setting only applies to the Prompt Window interface. */
|
|
518
518
|
get requiredMessage() {
|
|
519
519
|
return this.nativeElement ? this.nativeElement.requiredMessage : undefined;
|
|
520
520
|
}
|
|
521
521
|
set requiredMessage(value) {
|
|
522
522
|
this.nativeElement ? this.nativeElement.requiredMessage = value : undefined;
|
|
523
523
|
}
|
|
524
|
-
/** @description
|
|
524
|
+
/** @description Specifies whether the input field's content should be automatically highlighted (selected) when the field gains focus. Note: This setting applies specifically to the Prompt Window component. */
|
|
525
525
|
get selectAllOnFocus() {
|
|
526
526
|
return this.nativeElement ? this.nativeElement.selectAllOnFocus : undefined;
|
|
527
527
|
}
|
|
528
528
|
set selectAllOnFocus(value) {
|
|
529
529
|
this.nativeElement ? this.nativeElement.selectAllOnFocus = value : undefined;
|
|
530
530
|
}
|
|
531
|
-
/** @description
|
|
531
|
+
/** @description Specifies or retrieves the currently selected tab within the component. This property applies exclusively to the TabsWindow component. */
|
|
532
532
|
get selectedIndex() {
|
|
533
533
|
return this.nativeElement ? this.nativeElement.selectedIndex : undefined;
|
|
534
534
|
}
|
|
535
535
|
set selectedIndex(value) {
|
|
536
536
|
this.nativeElement ? this.nativeElement.selectedIndex = value : undefined;
|
|
537
537
|
}
|
|
538
|
-
/** @description
|
|
538
|
+
/** @description Specifies how the user is allowed to navigate between different tabs within the interface. This property is relevant only when using the TabsWindow component. */
|
|
539
539
|
get selectionMode() {
|
|
540
540
|
return this.nativeElement ? this.nativeElement.selectionMode : undefined;
|
|
541
541
|
}
|
|
542
542
|
set selectionMode(value) {
|
|
543
543
|
this.nativeElement ? this.nativeElement.selectionMode = value : undefined;
|
|
544
544
|
}
|
|
545
|
-
/** @description
|
|
545
|
+
/** @description Specifies the zero-based index position of the last character included in the current text selection. Note: This property is relevant only for use within MultilinePromptWindow components. */
|
|
546
546
|
get selectionEnd() {
|
|
547
547
|
return this.nativeElement ? this.nativeElement.selectionEnd : undefined;
|
|
548
548
|
}
|
|
549
549
|
set selectionEnd(value) {
|
|
550
550
|
this.nativeElement ? this.nativeElement.selectionEnd = value : undefined;
|
|
551
551
|
}
|
|
552
|
-
/** @description
|
|
552
|
+
/** @description Specifies the zero-based index of the first character in the currently selected text within the prompt window. This property is only applicable when using the MultilinePromptWindow component. */
|
|
553
553
|
get selectionStart() {
|
|
554
554
|
return this.nativeElement ? this.nativeElement.selectionStart : undefined;
|
|
555
555
|
}
|
|
556
556
|
set selectionStart(value) {
|
|
557
557
|
this.nativeElement ? this.nativeElement.selectionStart = value : undefined;
|
|
558
558
|
}
|
|
559
|
-
/** @description
|
|
559
|
+
/** @description Controls the visibility of the label displayed on the Progress Bar. Note: This setting is only applicable when used within the Progress Window component. */
|
|
560
560
|
get showProgressValue() {
|
|
561
561
|
return this.nativeElement ? this.nativeElement.showProgressValue : undefined;
|
|
562
562
|
}
|
|
563
563
|
set showProgressValue(value) {
|
|
564
564
|
this.nativeElement ? this.nativeElement.showProgressValue = value : undefined;
|
|
565
565
|
}
|
|
566
|
-
/** @description A getter that
|
|
566
|
+
/** @description A getter that retrieves all sibling LayoutPanel instances—those sharing the same immediate parent—when a LayoutPanel item is docked within a DockingLayout. The returned siblings are also DockingLayout items (specifically, other LayoutPanels). This property is only available for TabsWindow components that are docked inside a DockingLayout. */
|
|
567
567
|
get siblings() {
|
|
568
568
|
return this.nativeElement ? this.nativeElement.siblings : undefined;
|
|
569
569
|
}
|
|
570
570
|
set siblings(value) {
|
|
571
571
|
this.nativeElement ? this.nativeElement.siblings = value : undefined;
|
|
572
572
|
}
|
|
573
|
-
/** @description
|
|
573
|
+
/** @description Relevant when a TabsWindow component is nested within a DockingLayout custom element. This property specifies the size (width or height, depending on layout orientation) allocated to the TabsWindow within the docking layout, allowing developers to control how much space the window occupies relative to other docked components. */
|
|
574
574
|
get size() {
|
|
575
575
|
return this.nativeElement ? this.nativeElement.size : undefined;
|
|
576
576
|
}
|
|
577
577
|
set size(value) {
|
|
578
578
|
this.nativeElement ? this.nativeElement.size = value : undefined;
|
|
579
579
|
}
|
|
580
|
-
/** @description
|
|
580
|
+
/** @description Indicates whether spelling and grammar checking should be enabled for the element. This property determines if the content entered within the element will be reviewed for spelling and grammatical errors. Note: This option is only relevant for the MultilinePromptWindow component. */
|
|
581
581
|
get spellCheck() {
|
|
582
582
|
return this.nativeElement ? this.nativeElement.spellCheck : undefined;
|
|
583
583
|
}
|
|
584
584
|
set spellCheck(value) {
|
|
585
585
|
this.nativeElement ? this.nativeElement.spellCheck = value : undefined;
|
|
586
586
|
}
|
|
587
|
-
/** @description
|
|
587
|
+
/** @description Determines whether close buttons are shown on each tab within the Tab Strip of the TabsWindow. You can use this property to enable or disable the visibility of close buttons on tabs, allowing users to close individual tabs directly from the Tab Strip. Note: This property is only applicable to the TabsWindow component. */
|
|
588
588
|
get tabCloseButtons() {
|
|
589
589
|
return this.nativeElement ? this.nativeElement.tabCloseButtons : undefined;
|
|
590
590
|
}
|
|
591
591
|
set tabCloseButtons(value) {
|
|
592
592
|
this.nativeElement ? this.nativeElement.tabCloseButtons = value : undefined;
|
|
593
593
|
}
|
|
594
|
-
/** @description
|
|
594
|
+
/** @description Specifies when the close button is visible—either only when a tab is selected or always visible on all tabs. Note: This property applies exclusively to the TabsWindow component. */
|
|
595
595
|
get tabCloseButtonMode() {
|
|
596
596
|
return this.nativeElement ? this.nativeElement.tabCloseButtonMode : undefined;
|
|
597
597
|
}
|
|
598
598
|
set tabCloseButtonMode(value) {
|
|
599
599
|
this.nativeElement ? this.nativeElement.tabCloseButtonMode = value : undefined;
|
|
600
600
|
}
|
|
601
|
-
/** @description
|
|
601
|
+
/** @description Specifies how the scroll buttons for tabs are displayed or behave. This option is only relevant when the tabLayout property is set to 'scroll', allowing tabs to be scrolled horizontally. Note: This property applies exclusively to the TabsWindow component. */
|
|
602
602
|
get tabOverflow() {
|
|
603
603
|
return this.nativeElement ? this.nativeElement.tabOverflow : undefined;
|
|
604
604
|
}
|
|
605
605
|
set tabOverflow(value) {
|
|
606
606
|
this.nativeElement ? this.nativeElement.tabOverflow = value : undefined;
|
|
607
607
|
}
|
|
608
|
-
/** @description
|
|
608
|
+
/** @description Determines the position of the Tab Strip within the TabsWindow. Note: This property applies exclusively to the TabsWindow component. */
|
|
609
609
|
get tabPosition() {
|
|
610
610
|
return this.nativeElement ? this.nativeElement.tabPosition : undefined;
|
|
611
611
|
}
|
|
612
612
|
set tabPosition(value) {
|
|
613
613
|
this.nativeElement ? this.nativeElement.tabPosition = value : undefined;
|
|
614
614
|
}
|
|
615
|
-
/** @description
|
|
615
|
+
/** @description Defines or retrieves the position of the scroll buttons located within the tab header of a TabsWindow component. This setting is exclusively applicable to TabsWindow instances and allows you to control where the scroll buttons appear (for example, at the start, end, or both ends of the tab header). */
|
|
616
616
|
get tabScrollButtonsPosition() {
|
|
617
617
|
return this.nativeElement ? this.nativeElement.tabScrollButtonsPosition : undefined;
|
|
618
618
|
}
|
|
619
619
|
set tabScrollButtonsPosition(value) {
|
|
620
620
|
this.nativeElement ? this.nativeElement.tabScrollButtonsPosition = value : undefined;
|
|
621
621
|
}
|
|
622
|
-
/** @description
|
|
622
|
+
/** @description Defines or retrieves the orientation of the text displayed in the tab labels within the TabsWindow component. This property determines whether the tab text is laid out horizontally or vertically. Note: This property is exclusively applicable to the TabsWindow component and has no effect on other components. */
|
|
623
623
|
get tabTextOrientation() {
|
|
624
624
|
return this.nativeElement ? this.nativeElement.tabTextOrientation : undefined;
|
|
625
625
|
}
|
|
626
626
|
set tabTextOrientation(value) {
|
|
627
627
|
this.nativeElement ? this.nativeElement.tabTextOrientation = value : undefined;
|
|
628
628
|
}
|
|
629
|
-
/** @description
|
|
629
|
+
/** @description Specifies the visual theme to be applied. The theme controls the appearance, including colors, fonts, and styling, of the element to ensure a consistent look and feel across the user interface. */
|
|
630
630
|
get theme() {
|
|
631
631
|
return this.nativeElement ? this.nativeElement.theme : undefined;
|
|
632
632
|
}
|
|
633
633
|
set theme(value) {
|
|
634
634
|
this.nativeElement ? this.nativeElement.theme = value : undefined;
|
|
635
635
|
}
|
|
636
|
-
/** @description If is set to true, the element cannot be
|
|
636
|
+
/** @description If this property is set to true, the element will be excluded from keyboard navigation and cannot receive focus either programmatically or via user interaction. This ensures that users will be unable to focus on the element using methods such as the Tab key or calling focus() in JavaScript. */
|
|
637
637
|
get unfocusable() {
|
|
638
638
|
return this.nativeElement ? this.nativeElement.unfocusable : undefined;
|
|
639
639
|
}
|
|
640
640
|
set unfocusable(value) {
|
|
641
641
|
this.nativeElement ? this.nativeElement.unfocusable = value : undefined;
|
|
642
642
|
}
|
|
643
|
-
/** @description
|
|
643
|
+
/** @description Specifies the current value displayed within the TextBox or ProgressBar component inside a Dialog, Prompt, or Progress Window. This value can represent user input (for TextBox) or progress status (for ProgressBar) and is used to dynamically update the UI element's content or state. */
|
|
644
644
|
get value() {
|
|
645
645
|
return this.nativeElement ? this.nativeElement.value : undefined;
|
|
646
646
|
}
|
|
647
647
|
set value(value) {
|
|
648
648
|
this.nativeElement ? this.nativeElement.value = value : undefined;
|
|
649
649
|
}
|
|
650
|
-
/** @description
|
|
650
|
+
/** @description Specifies the actual parent element of the target element. The window's sizing and movement are restricted to the boundaries of this parent element, meaning the window can only be resized or repositioned within the visible area of the designated parent. */
|
|
651
651
|
get windowParent() {
|
|
652
652
|
return this.nativeElement ? this.nativeElement.windowParent : undefined;
|
|
653
653
|
}
|
|
654
654
|
set windowParent(value) {
|
|
655
655
|
this.nativeElement ? this.nativeElement.windowParent = value : undefined;
|
|
656
656
|
}
|
|
657
|
-
/** @description
|
|
657
|
+
/** @description Specifies the text-wrapping behavior for the input field. Note: This property is only relevant when used with the MultilinePromptWindow component. */
|
|
658
658
|
get wrap() {
|
|
659
659
|
return this.nativeElement ? this.nativeElement.wrap : undefined;
|
|
660
660
|
}
|
|
661
661
|
set wrap(value) {
|
|
662
662
|
this.nativeElement ? this.nativeElement.wrap = value : undefined;
|
|
663
663
|
}
|
|
664
|
-
/** @description Appends a
|
|
664
|
+
/** @description Appends a new tab item to the end of the existing list of tab items within the specified parent element. This operation updates the parent element's tab item collection, ensuring the new tab appears as the last item in the tab navigation.
|
|
665
665
|
* @param {Node} node. A TabItem element that should be added to the rest of the items as the last item.
|
|
666
666
|
* @returns {Node}
|
|
667
667
|
*/
|
|
@@ -677,7 +677,13 @@ class WindowComponent extends BaseElement {
|
|
|
677
677
|
const result = await getResultOnRender();
|
|
678
678
|
return result;
|
|
679
679
|
}
|
|
680
|
-
|
|
680
|
+
appendChildSync(node) {
|
|
681
|
+
if (this.nativeElement.isRendered) {
|
|
682
|
+
return this.nativeElement.appendChild(node);
|
|
683
|
+
}
|
|
684
|
+
return null;
|
|
685
|
+
}
|
|
686
|
+
/** @description Sets the window to the highest z-order level, bringing it to the foreground and ensuring it is visible and accessible for user interaction above all other open windows.
|
|
681
687
|
*/
|
|
682
688
|
bringToFront() {
|
|
683
689
|
if (this.nativeElement.isRendered) {
|
|
@@ -689,7 +695,7 @@ class WindowComponent extends BaseElement {
|
|
|
689
695
|
});
|
|
690
696
|
}
|
|
691
697
|
}
|
|
692
|
-
/** @description
|
|
698
|
+
/** @description Removes all existing content from the window, effectively resetting the window’s display area to an empty state. This operation clears any text, images, or elements currently visible within the window.
|
|
693
699
|
*/
|
|
694
700
|
clear() {
|
|
695
701
|
if (this.nativeElement.isRendered) {
|
|
@@ -701,7 +707,7 @@ class WindowComponent extends BaseElement {
|
|
|
701
707
|
});
|
|
702
708
|
}
|
|
703
709
|
}
|
|
704
|
-
/** @description Closes the window.
|
|
710
|
+
/** @description Closes the currently active window in the application, terminating its user interface and releasing any associated resources. If there are unsaved changes or prompts, the user may be asked to confirm before the window is closed.
|
|
705
711
|
*/
|
|
706
712
|
close() {
|
|
707
713
|
if (this.nativeElement.isRendered) {
|
|
@@ -713,7 +719,7 @@ class WindowComponent extends BaseElement {
|
|
|
713
719
|
});
|
|
714
720
|
}
|
|
715
721
|
}
|
|
716
|
-
/** @description
|
|
722
|
+
/** @description Minimizes the window, reducing it to a smaller icon or hidden state, without closing the application.
|
|
717
723
|
* @returns {HTMLElement}
|
|
718
724
|
*/
|
|
719
725
|
async collapse() {
|
|
@@ -728,7 +734,13 @@ class WindowComponent extends BaseElement {
|
|
|
728
734
|
const result = await getResultOnRender();
|
|
729
735
|
return result;
|
|
730
736
|
}
|
|
731
|
-
|
|
737
|
+
collapseSync() {
|
|
738
|
+
if (this.nativeElement.isRendered) {
|
|
739
|
+
return this.nativeElement.collapse();
|
|
740
|
+
}
|
|
741
|
+
return null;
|
|
742
|
+
}
|
|
743
|
+
/** @description Ensures the specified tab item is brought into view by automatically scrolling the tab bar as needed. This functionality is exclusive to the TabsWindow component.
|
|
732
744
|
* @param {number} index. The index of the tab to scroll to.
|
|
733
745
|
*/
|
|
734
746
|
ensureVisible(index) {
|
|
@@ -741,7 +753,7 @@ class WindowComponent extends BaseElement {
|
|
|
741
753
|
});
|
|
742
754
|
}
|
|
743
755
|
}
|
|
744
|
-
/** @description
|
|
756
|
+
/** @description Restores the window to its full size and visibility after it has been collapsed or minimized, allowing users to view and interact with its contents again.
|
|
745
757
|
* @returns {any[]}
|
|
746
758
|
*/
|
|
747
759
|
async expand() {
|
|
@@ -756,7 +768,13 @@ class WindowComponent extends BaseElement {
|
|
|
756
768
|
const result = await getResultOnRender();
|
|
757
769
|
return result;
|
|
758
770
|
}
|
|
759
|
-
|
|
771
|
+
expandSync() {
|
|
772
|
+
if (this.nativeElement.isRendered) {
|
|
773
|
+
return this.nativeElement.expand();
|
|
774
|
+
}
|
|
775
|
+
return null;
|
|
776
|
+
}
|
|
777
|
+
/** @description Inserts a new tab along with its corresponding content section into the user interface. This function is specifically designed for use within the TabsWindow component and will not operate outside of this context.
|
|
760
778
|
* @param {number} index. The index to insert a new tab at.
|
|
761
779
|
* @param {any} details. An Object with the fields "label", "labelSize", "content" and "group".
|
|
762
780
|
*/
|
|
@@ -770,7 +788,7 @@ class WindowComponent extends BaseElement {
|
|
|
770
788
|
});
|
|
771
789
|
}
|
|
772
790
|
}
|
|
773
|
-
/** @description Inserts the specified "smart-tab-item" node before the reference "smart-tab-item" node.
|
|
791
|
+
/** @description Inserts the specified "smart-tab-item" node directly before the reference "smart-tab-item" node within the tab collection. This operation is only applicable when manipulating tab items inside a TabsWindow component.
|
|
774
792
|
* @param {Node} newNode. The "smart-tab-item" node to insert.
|
|
775
793
|
* @param {Node | null} referenceNode?. The "smart-tab-item" node before which newNode is inserted.
|
|
776
794
|
* @returns {Node}
|
|
@@ -787,7 +805,13 @@ class WindowComponent extends BaseElement {
|
|
|
787
805
|
const result = await getResultOnRender();
|
|
788
806
|
return result;
|
|
789
807
|
}
|
|
790
|
-
|
|
808
|
+
insertBeforeSync(newNode, referenceNode) {
|
|
809
|
+
if (this.nativeElement.isRendered) {
|
|
810
|
+
return this.nativeElement.insertBefore(newNode, referenceNode);
|
|
811
|
+
}
|
|
812
|
+
return null;
|
|
813
|
+
}
|
|
814
|
+
/** @description Revised Description:"Sets the window's position on the screen by moving it to specified X and Y coordinates, effectively relocating the window to a new location."
|
|
791
815
|
* @param {string | number} left. Left position. For example: '100px'.
|
|
792
816
|
* @param {string | number} top. Top position. For example: '100px'.
|
|
793
817
|
*/
|
|
@@ -801,7 +825,7 @@ class WindowComponent extends BaseElement {
|
|
|
801
825
|
});
|
|
802
826
|
}
|
|
803
827
|
}
|
|
804
|
-
/** @description
|
|
828
|
+
/** @description Expands the window to occupy the entire available viewing area, ensuring it fills all usable screen space without overlapping system taskbars or menus.
|
|
805
829
|
*/
|
|
806
830
|
maximize() {
|
|
807
831
|
if (this.nativeElement.isRendered) {
|
|
@@ -813,7 +837,7 @@ class WindowComponent extends BaseElement {
|
|
|
813
837
|
});
|
|
814
838
|
}
|
|
815
839
|
}
|
|
816
|
-
/** @description
|
|
840
|
+
/** @description Reduces the window to the taskbar or dock, temporarily hiding it from view without closing the application.
|
|
817
841
|
*/
|
|
818
842
|
minimize() {
|
|
819
843
|
if (this.nativeElement.isRendered) {
|
|
@@ -825,7 +849,7 @@ class WindowComponent extends BaseElement {
|
|
|
825
849
|
});
|
|
826
850
|
}
|
|
827
851
|
}
|
|
828
|
-
/** @description Opens the
|
|
852
|
+
/** @description Opens a new browser window or tab with the specified URL or content, allowing additional web pages or resources to be displayed alongside the current page.
|
|
829
853
|
*/
|
|
830
854
|
open() {
|
|
831
855
|
if (this.nativeElement.isRendered) {
|
|
@@ -837,7 +861,7 @@ class WindowComponent extends BaseElement {
|
|
|
837
861
|
});
|
|
838
862
|
}
|
|
839
863
|
}
|
|
840
|
-
/** @description
|
|
864
|
+
/** @description Prevents the window from being moved by locking its position. Disables the ability to drag or reposition the window, ensuring it remains fixed in place.
|
|
841
865
|
*/
|
|
842
866
|
pin() {
|
|
843
867
|
if (this.nativeElement.isRendered) {
|
|
@@ -849,7 +873,7 @@ class WindowComponent extends BaseElement {
|
|
|
849
873
|
});
|
|
850
874
|
}
|
|
851
875
|
}
|
|
852
|
-
/** @description Removes a tab
|
|
876
|
+
/** @description Removes a tab along with its corresponding content section from the interface. This function is designed to work exclusively within the TabsWindow component.
|
|
853
877
|
* @param {number} index. The index of the tab to remove.
|
|
854
878
|
*/
|
|
855
879
|
removeAt(index) {
|
|
@@ -862,7 +886,7 @@ class WindowComponent extends BaseElement {
|
|
|
862
886
|
});
|
|
863
887
|
}
|
|
864
888
|
}
|
|
865
|
-
/** @description Removes a child "smart-tab-item"
|
|
889
|
+
/** @description Removes a child node with the "smart-tab-item" tag from the parent container. Note: This operation is only supported within the TabsWindow component; attempting to use it elsewhere will have no effect.
|
|
866
890
|
* @param {Node} node. The "smart-tab-item" node to remove.
|
|
867
891
|
* @returns {Node}
|
|
868
892
|
*/
|
|
@@ -878,7 +902,13 @@ class WindowComponent extends BaseElement {
|
|
|
878
902
|
const result = await getResultOnRender();
|
|
879
903
|
return result;
|
|
880
904
|
}
|
|
881
|
-
|
|
905
|
+
removeChildSync(node) {
|
|
906
|
+
if (this.nativeElement.isRendered) {
|
|
907
|
+
return this.nativeElement.removeChild(node);
|
|
908
|
+
}
|
|
909
|
+
return null;
|
|
910
|
+
}
|
|
911
|
+
/** @description Restores the window to its previous dimensions and position before it was maximized or minimized, returning it to the exact size and location it had prior to those actions.
|
|
882
912
|
*/
|
|
883
913
|
restore() {
|
|
884
914
|
if (this.nativeElement.isRendered) {
|
|
@@ -890,7 +920,7 @@ class WindowComponent extends BaseElement {
|
|
|
890
920
|
});
|
|
891
921
|
}
|
|
892
922
|
}
|
|
893
|
-
/** @description Selects
|
|
923
|
+
/** @description Selects the specified tab within the interface. This action applies exclusively to elements of type TabsWindow.
|
|
894
924
|
* @param {number} index. The index of the tab to select.
|
|
895
925
|
*/
|
|
896
926
|
select(index) {
|
|
@@ -903,7 +933,7 @@ class WindowComponent extends BaseElement {
|
|
|
903
933
|
});
|
|
904
934
|
}
|
|
905
935
|
}
|
|
906
|
-
/** @description
|
|
936
|
+
/** @description Removes the pinned (fixed) state from the window, allowing the user to freely move or drag the window to a different position on the screen.
|
|
907
937
|
*/
|
|
908
938
|
unpin() {
|
|
909
939
|
if (this.nativeElement.isRendered) {
|
|
@@ -915,7 +945,7 @@ class WindowComponent extends BaseElement {
|
|
|
915
945
|
});
|
|
916
946
|
}
|
|
917
947
|
}
|
|
918
|
-
/** @description Updates the header label.
|
|
948
|
+
/** @description Updates the text displayed in the header label to reflect new information or changes, ensuring that the header accurately represents the current content or context of the section.
|
|
919
949
|
* @param {string} label. The new label of the Header.
|
|
920
950
|
*/
|
|
921
951
|
updateLabel(label) {
|
|
@@ -928,7 +958,7 @@ class WindowComponent extends BaseElement {
|
|
|
928
958
|
});
|
|
929
959
|
}
|
|
930
960
|
}
|
|
931
|
-
/** @description
|
|
961
|
+
/** @description Replaces the existing content with new or modified information, ensuring that the displayed data reflects the latest updates or changes.
|
|
932
962
|
* @param {string | HTMLElement} content. The new content of the window.
|
|
933
963
|
*/
|
|
934
964
|
updateContent(content) {
|
|
@@ -941,7 +971,7 @@ class WindowComponent extends BaseElement {
|
|
|
941
971
|
});
|
|
942
972
|
}
|
|
943
973
|
}
|
|
944
|
-
/** @description Updates
|
|
974
|
+
/** @description Updates an individual tab within a TabsWindow component and modifies its corresponding content section. This operation exclusively applies to elements of the TabsWindow type. Use this function to change tab labels, update active states, or refresh the content associated with a specific tab within the TabsWindow interface.
|
|
945
975
|
* @param {number} index. The index of the tab to update.
|
|
946
976
|
* @param {string} label. The new label of the tab. The value can be the id of an HTMLTemplateElement
|
|
947
977
|
* @param {string | HTMLElement} content. The new content of the tab.
|