@sapui5/types 1.113.0
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/LICENSE.txt +35 -0
- package/README.md +35 -0
- package/package.json +23 -0
- package/types/index.d.ts +67 -0
- package/types/sap.apf.d.ts +1026 -0
- package/types/sap.ca.ui.d.ts +14005 -0
- package/types/sap.chart.d.ts +4815 -0
- package/types/sap.collaboration.d.ts +2704 -0
- package/types/sap.esh.search.ui.d.ts +1595 -0
- package/types/sap.f.d.ts +20085 -0
- package/types/sap.fe.core.d.ts +1508 -0
- package/types/sap.fe.macros.d.ts +975 -0
- package/types/sap.fe.navigation.d.ts +917 -0
- package/types/sap.fe.templates.d.ts +522 -0
- package/types/sap.fe.test.d.ts +3533 -0
- package/types/sap.feedback.ui.d.ts +3 -0
- package/types/sap.gantt.d.ts +51684 -0
- package/types/sap.insights.d.ts +23 -0
- package/types/sap.landvisz.d.ts +7952 -0
- package/types/sap.m.d.ts +147796 -0
- package/types/sap.makit.d.ts +4533 -0
- package/types/sap.me.d.ts +3665 -0
- package/types/sap.ndc.d.ts +774 -0
- package/types/sap.ovp.d.ts +176 -0
- package/types/sap.rules.ui.d.ts +1471 -0
- package/types/sap.sac.df.d.ts +2292 -0
- package/types/sap.sac.grid.d.ts +774 -0
- package/types/sap.suite.ui.commons.d.ts +46971 -0
- package/types/sap.suite.ui.generic.template.d.ts +3431 -0
- package/types/sap.suite.ui.microchart.d.ts +12652 -0
- package/types/sap.tnt.d.ts +2227 -0
- package/types/sap.ui.codeeditor.d.ts +693 -0
- package/types/sap.ui.commons.d.ts +30235 -0
- package/types/sap.ui.comp.d.ts +37411 -0
- package/types/sap.ui.core.d.ts +78872 -0
- package/types/sap.ui.dt.d.ts +3 -0
- package/types/sap.ui.export.d.ts +843 -0
- package/types/sap.ui.fl.d.ts +1663 -0
- package/types/sap.ui.generic.app.d.ts +2683 -0
- package/types/sap.ui.generic.template.d.ts +3 -0
- package/types/sap.ui.integration.d.ts +4032 -0
- package/types/sap.ui.layout.d.ts +14472 -0
- package/types/sap.ui.mdc.d.ts +476 -0
- package/types/sap.ui.richtexteditor.d.ts +1666 -0
- package/types/sap.ui.rta.d.ts +124 -0
- package/types/sap.ui.suite.d.ts +685 -0
- package/types/sap.ui.support.d.ts +453 -0
- package/types/sap.ui.table.d.ts +9325 -0
- package/types/sap.ui.testrecorder.d.ts +9 -0
- package/types/sap.ui.unified.d.ts +20640 -0
- package/types/sap.ui.ux3.d.ts +18288 -0
- package/types/sap.ui.vbm.d.ts +17251 -0
- package/types/sap.ui.vk.d.ts +42381 -0
- package/types/sap.ui.vtm.d.ts +10547 -0
- package/types/sap.ui.webc.common.d.ts +113 -0
- package/types/sap.ui.webc.fiori.d.ts +13850 -0
- package/types/sap.ui.webc.main.d.ts +40833 -0
- package/types/sap.uiext.inbox.d.ts +4079 -0
- package/types/sap.ushell.d.ts +10255 -0
- package/types/sap.ushell_abap.d.ts +9 -0
- package/types/sap.uxap.d.ts +7636 -0
- package/types/sap.viz.d.ts +51209 -0
- package/types/sap.webanalytics.core.d.ts +3 -0
- package/types/sap.zen.commons.d.ts +1542 -0
- package/types/sap.zen.crosstab.d.ts +1159 -0
- package/types/sap.zen.dsh.d.ts +2132 -0
|
@@ -0,0 +1,2227 @@
|
|
|
1
|
+
// For Library Version: 1.113.0
|
|
2
|
+
|
|
3
|
+
declare module "sap/tnt/library" {
|
|
4
|
+
/**
|
|
5
|
+
* @SINCE 1.68
|
|
6
|
+
*
|
|
7
|
+
* Interface for controls suitable for the `header` aggregation of {@link sap.tnt.ToolPage}.
|
|
8
|
+
*/
|
|
9
|
+
export interface IToolHeader {
|
|
10
|
+
__implements__sap_tnt_IToolHeader: boolean;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Predefined types of `InfoLabel`
|
|
15
|
+
*/
|
|
16
|
+
export enum RenderMode {
|
|
17
|
+
/**
|
|
18
|
+
* When type of the content of `InfoLabel` is text padding are loose
|
|
19
|
+
*/
|
|
20
|
+
Loose = "Loose",
|
|
21
|
+
/**
|
|
22
|
+
* When type of the content of `InfoLabel` is numeric paddings are narrow
|
|
23
|
+
*/
|
|
24
|
+
Narrow = "Narrow",
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
declare module "sap/tnt/InfoLabel" {
|
|
29
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
30
|
+
|
|
31
|
+
import {
|
|
32
|
+
IFormContent,
|
|
33
|
+
URI,
|
|
34
|
+
TextDirection,
|
|
35
|
+
CSSSize,
|
|
36
|
+
} from "sap/ui/core/library";
|
|
37
|
+
|
|
38
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
39
|
+
|
|
40
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
41
|
+
|
|
42
|
+
import { RenderMode } from "sap/tnt/library";
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* @SINCE 1.54
|
|
46
|
+
*
|
|
47
|
+
* The `InfoLabel` is a small non-interactive control which contains text information and non-semantic color
|
|
48
|
+
* chosen from a list of predefined color schemes. It serves the purpose to attract the user attention to
|
|
49
|
+
* some piece of information (state, quantity, condition, etc.).
|
|
50
|
+
*
|
|
51
|
+
* Overview:
|
|
52
|
+
*
|
|
53
|
+
* The control visualizes text information without user interaction. The text inside the control is always
|
|
54
|
+
* in upper case. It can have smaller or larger side paddings which can be specified by the `renderMode`
|
|
55
|
+
* property. The text-background color pair can be changed by setting a number between 1 and 10 that corresponds
|
|
56
|
+
* to the 10 predefined color combinations of the `colorScheme` property. The control is designed to be
|
|
57
|
+
* vertically aligned with UI5 Input and Button control families. When using `InfoLabel` in non-editable
|
|
58
|
+
* `Forms`, `Tables`, etc., set `displayOnly=true` for best visual results.
|
|
59
|
+
*
|
|
60
|
+
* Usage Guidelines:
|
|
61
|
+
* - If the text is longer than the width of the control, it doesn’t wrap. Instead, it’s represented as
|
|
62
|
+
* ellipsis.
|
|
63
|
+
* - When truncated, the full text in the control is not visible. Therefore, it’s recommended to make
|
|
64
|
+
* more space for longer items to be fully displayed.
|
|
65
|
+
* - Colors are not semantic and have no visual representation in sap_belize_hcb and sap_belize_hcw themes.
|
|
66
|
+
*
|
|
67
|
+
* - The control shows plain text only, formatting is not visualized.
|
|
68
|
+
*/
|
|
69
|
+
export default class InfoLabel extends Control implements IFormContent {
|
|
70
|
+
__implements__sap_ui_core_IFormContent: boolean;
|
|
71
|
+
/**
|
|
72
|
+
* Constructor for a new `InfoLabel`.
|
|
73
|
+
*
|
|
74
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
75
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
76
|
+
* of the syntax of the settings object.
|
|
77
|
+
*/
|
|
78
|
+
constructor(
|
|
79
|
+
/**
|
|
80
|
+
* Initial settings for the new control
|
|
81
|
+
*/
|
|
82
|
+
mSettings?: $InfoLabelSettings
|
|
83
|
+
);
|
|
84
|
+
/**
|
|
85
|
+
* Constructor for a new `InfoLabel`.
|
|
86
|
+
*
|
|
87
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
88
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
89
|
+
* of the syntax of the settings object.
|
|
90
|
+
*/
|
|
91
|
+
constructor(
|
|
92
|
+
/**
|
|
93
|
+
* ID for the new control, generated automatically if no ID is given
|
|
94
|
+
*/
|
|
95
|
+
sId?: string,
|
|
96
|
+
/**
|
|
97
|
+
* Initial settings for the new control
|
|
98
|
+
*/
|
|
99
|
+
mSettings?: $InfoLabelSettings
|
|
100
|
+
);
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* Creates a new subclass of class sap.tnt.InfoLabel with name `sClassName` and enriches it with the information
|
|
104
|
+
* contained in `oClassInfo`.
|
|
105
|
+
*
|
|
106
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
107
|
+
*
|
|
108
|
+
* @returns Created class / constructor function
|
|
109
|
+
*/
|
|
110
|
+
static extend<T extends Record<string, unknown>>(
|
|
111
|
+
/**
|
|
112
|
+
* Name of the class being created
|
|
113
|
+
*/
|
|
114
|
+
sClassName: string,
|
|
115
|
+
/**
|
|
116
|
+
* Object literal with information about the class
|
|
117
|
+
*/
|
|
118
|
+
oClassInfo?: sap.ClassInfo<T, InfoLabel>,
|
|
119
|
+
/**
|
|
120
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
121
|
+
* used by this class
|
|
122
|
+
*/
|
|
123
|
+
FNMetaImpl?: Function
|
|
124
|
+
): Function;
|
|
125
|
+
/**
|
|
126
|
+
* Returns a metadata object for class sap.tnt.InfoLabel.
|
|
127
|
+
*
|
|
128
|
+
* @returns Metadata object describing this class
|
|
129
|
+
*/
|
|
130
|
+
static getMetadata(): ElementMetadata;
|
|
131
|
+
/**
|
|
132
|
+
* Binds property {@link #getText text} to model data.
|
|
133
|
+
*
|
|
134
|
+
* See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description
|
|
135
|
+
* of the possible properties of `oBindingInfo`
|
|
136
|
+
*
|
|
137
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
138
|
+
*/
|
|
139
|
+
bindText(
|
|
140
|
+
/**
|
|
141
|
+
* The binding information
|
|
142
|
+
*/
|
|
143
|
+
oBindingInfo: PropertyBindingInfo
|
|
144
|
+
): this;
|
|
145
|
+
/**
|
|
146
|
+
* Gets current value of property {@link #getColorScheme colorScheme}.
|
|
147
|
+
*
|
|
148
|
+
* Specifies the fill and text color of the control. Accepts a number between 1 and 10 as a value. You can
|
|
149
|
+
* choose from 10 predefined background and text color combinations. The color schemes are non-semantic,
|
|
150
|
+
* you can select them according to your own preferences. **Note:** ColorScheme 10 is available only in
|
|
151
|
+
* Fiori 3 theme. The default `colorScheme` is 7.
|
|
152
|
+
*
|
|
153
|
+
* Default value is `7`.
|
|
154
|
+
*
|
|
155
|
+
* @returns Value of property `colorScheme`
|
|
156
|
+
*/
|
|
157
|
+
getColorScheme(): int;
|
|
158
|
+
/**
|
|
159
|
+
* Gets current value of property {@link #getDisplayOnly displayOnly}.
|
|
160
|
+
*
|
|
161
|
+
* Determines if the `InfoLabel` is in `displayOnly` mode. When set to `true` the control size adjusts to
|
|
162
|
+
* fit other controls, for example non-editable `Forms`.
|
|
163
|
+
*
|
|
164
|
+
* Default value is `false`.
|
|
165
|
+
*
|
|
166
|
+
* @returns Value of property `displayOnly`
|
|
167
|
+
*/
|
|
168
|
+
getDisplayOnly(): boolean;
|
|
169
|
+
/**
|
|
170
|
+
* @SINCE 1.74
|
|
171
|
+
*
|
|
172
|
+
* Gets current value of property {@link #getIcon icon}.
|
|
173
|
+
*
|
|
174
|
+
* Defines the icon to be displayed as graphical element within the `InfoLabel`. It can be an icon from
|
|
175
|
+
* the icon font.
|
|
176
|
+
*
|
|
177
|
+
* Default value is `empty string`.
|
|
178
|
+
*
|
|
179
|
+
* @returns Value of property `icon`
|
|
180
|
+
*/
|
|
181
|
+
getIcon(): URI;
|
|
182
|
+
/**
|
|
183
|
+
* Gets current value of property {@link #getRenderMode renderMode}.
|
|
184
|
+
*
|
|
185
|
+
* Specifies the type of the `InfoLabel` paddings - loose or narrow. **Note:** By default the padding is
|
|
186
|
+
* loose. It is recommended to use narrow (smaller) paddings for numeric texts.
|
|
187
|
+
*
|
|
188
|
+
* Default value is `Loose`.
|
|
189
|
+
*
|
|
190
|
+
* @returns Value of property `renderMode`
|
|
191
|
+
*/
|
|
192
|
+
getRenderMode(): RenderMode | keyof typeof RenderMode;
|
|
193
|
+
/**
|
|
194
|
+
* Gets current value of property {@link #getText text}.
|
|
195
|
+
*
|
|
196
|
+
* Specifies the text inside the `InfoLabel` control.
|
|
197
|
+
*
|
|
198
|
+
* Default value is `empty string`.
|
|
199
|
+
*
|
|
200
|
+
* @returns Value of property `text`
|
|
201
|
+
*/
|
|
202
|
+
getText(): string;
|
|
203
|
+
/**
|
|
204
|
+
* Gets current value of property {@link #getTextDirection textDirection}.
|
|
205
|
+
*
|
|
206
|
+
* Available options for the text direction are LTR and RTL. By default the control inherits the text direction
|
|
207
|
+
* from its parent control.
|
|
208
|
+
*
|
|
209
|
+
* Default value is `Inherit`.
|
|
210
|
+
*
|
|
211
|
+
* @returns Value of property `textDirection`
|
|
212
|
+
*/
|
|
213
|
+
getTextDirection(): TextDirection | keyof typeof TextDirection;
|
|
214
|
+
/**
|
|
215
|
+
* Gets current value of property {@link #getWidth width}.
|
|
216
|
+
*
|
|
217
|
+
* Specifies the width of the `InfoLabel` control. By default, the `InfoLabel` control has the width of
|
|
218
|
+
* the content. Set this property to restrict the width to a custom value.
|
|
219
|
+
*
|
|
220
|
+
* @returns Value of property `width`
|
|
221
|
+
*/
|
|
222
|
+
getWidth(): CSSSize;
|
|
223
|
+
/**
|
|
224
|
+
* Sets a new value for property {@link #getColorScheme colorScheme}.
|
|
225
|
+
*
|
|
226
|
+
* Specifies the fill and text color of the control. Accepts a number between 1 and 10 as a value. You can
|
|
227
|
+
* choose from 10 predefined background and text color combinations. The color schemes are non-semantic,
|
|
228
|
+
* you can select them according to your own preferences. **Note:** ColorScheme 10 is available only in
|
|
229
|
+
* Fiori 3 theme. The default `colorScheme` is 7.
|
|
230
|
+
*
|
|
231
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
232
|
+
*
|
|
233
|
+
* Default value is `7`.
|
|
234
|
+
*
|
|
235
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
236
|
+
*/
|
|
237
|
+
setColorScheme(
|
|
238
|
+
/**
|
|
239
|
+
* New value for property `colorScheme`
|
|
240
|
+
*/
|
|
241
|
+
iColorScheme?: int
|
|
242
|
+
): this;
|
|
243
|
+
/**
|
|
244
|
+
* Sets a new value for property {@link #getDisplayOnly displayOnly}.
|
|
245
|
+
*
|
|
246
|
+
* Determines if the `InfoLabel` is in `displayOnly` mode. When set to `true` the control size adjusts to
|
|
247
|
+
* fit other controls, for example non-editable `Forms`.
|
|
248
|
+
*
|
|
249
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
250
|
+
*
|
|
251
|
+
* Default value is `false`.
|
|
252
|
+
*
|
|
253
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
254
|
+
*/
|
|
255
|
+
setDisplayOnly(
|
|
256
|
+
/**
|
|
257
|
+
* New value for property `displayOnly`
|
|
258
|
+
*/
|
|
259
|
+
bDisplayOnly?: boolean
|
|
260
|
+
): this;
|
|
261
|
+
/**
|
|
262
|
+
* @SINCE 1.74
|
|
263
|
+
*
|
|
264
|
+
* Sets a new value for property {@link #getIcon icon}.
|
|
265
|
+
*
|
|
266
|
+
* Defines the icon to be displayed as graphical element within the `InfoLabel`. It can be an icon from
|
|
267
|
+
* the icon font.
|
|
268
|
+
*
|
|
269
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
270
|
+
*
|
|
271
|
+
* Default value is `empty string`.
|
|
272
|
+
*
|
|
273
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
274
|
+
*/
|
|
275
|
+
setIcon(
|
|
276
|
+
/**
|
|
277
|
+
* New value for property `icon`
|
|
278
|
+
*/
|
|
279
|
+
sIcon?: URI
|
|
280
|
+
): this;
|
|
281
|
+
/**
|
|
282
|
+
* Sets a new value for property {@link #getRenderMode renderMode}.
|
|
283
|
+
*
|
|
284
|
+
* Specifies the type of the `InfoLabel` paddings - loose or narrow. **Note:** By default the padding is
|
|
285
|
+
* loose. It is recommended to use narrow (smaller) paddings for numeric texts.
|
|
286
|
+
*
|
|
287
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
288
|
+
*
|
|
289
|
+
* Default value is `Loose`.
|
|
290
|
+
*
|
|
291
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
292
|
+
*/
|
|
293
|
+
setRenderMode(
|
|
294
|
+
/**
|
|
295
|
+
* New value for property `renderMode`
|
|
296
|
+
*/
|
|
297
|
+
sRenderMode?: RenderMode | keyof typeof RenderMode
|
|
298
|
+
): this;
|
|
299
|
+
/**
|
|
300
|
+
* Sets a new value for property {@link #getText text}.
|
|
301
|
+
*
|
|
302
|
+
* Specifies the text inside the `InfoLabel` control.
|
|
303
|
+
*
|
|
304
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
305
|
+
*
|
|
306
|
+
* Default value is `empty string`.
|
|
307
|
+
*
|
|
308
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
309
|
+
*/
|
|
310
|
+
setText(
|
|
311
|
+
/**
|
|
312
|
+
* New value for property `text`
|
|
313
|
+
*/
|
|
314
|
+
sText?: string
|
|
315
|
+
): this;
|
|
316
|
+
/**
|
|
317
|
+
* Sets a new value for property {@link #getTextDirection textDirection}.
|
|
318
|
+
*
|
|
319
|
+
* Available options for the text direction are LTR and RTL. By default the control inherits the text direction
|
|
320
|
+
* from its parent control.
|
|
321
|
+
*
|
|
322
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
323
|
+
*
|
|
324
|
+
* Default value is `Inherit`.
|
|
325
|
+
*
|
|
326
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
327
|
+
*/
|
|
328
|
+
setTextDirection(
|
|
329
|
+
/**
|
|
330
|
+
* New value for property `textDirection`
|
|
331
|
+
*/
|
|
332
|
+
sTextDirection?: TextDirection | keyof typeof TextDirection
|
|
333
|
+
): this;
|
|
334
|
+
/**
|
|
335
|
+
* Sets a new value for property {@link #getWidth width}.
|
|
336
|
+
*
|
|
337
|
+
* Specifies the width of the `InfoLabel` control. By default, the `InfoLabel` control has the width of
|
|
338
|
+
* the content. Set this property to restrict the width to a custom value.
|
|
339
|
+
*
|
|
340
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
341
|
+
*
|
|
342
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
343
|
+
*/
|
|
344
|
+
setWidth(
|
|
345
|
+
/**
|
|
346
|
+
* New value for property `width`
|
|
347
|
+
*/
|
|
348
|
+
sWidth?: CSSSize
|
|
349
|
+
): this;
|
|
350
|
+
/**
|
|
351
|
+
* Unbinds property {@link #getText text} from model data.
|
|
352
|
+
*
|
|
353
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
354
|
+
*/
|
|
355
|
+
unbindText(): this;
|
|
356
|
+
}
|
|
357
|
+
|
|
358
|
+
export interface $InfoLabelSettings extends $ControlSettings {
|
|
359
|
+
/**
|
|
360
|
+
* Specifies the text inside the `InfoLabel` control.
|
|
361
|
+
*/
|
|
362
|
+
text?: string | PropertyBindingInfo;
|
|
363
|
+
|
|
364
|
+
/**
|
|
365
|
+
* Specifies the type of the `InfoLabel` paddings - loose or narrow. **Note:** By default the padding is
|
|
366
|
+
* loose. It is recommended to use narrow (smaller) paddings for numeric texts.
|
|
367
|
+
*/
|
|
368
|
+
renderMode?:
|
|
369
|
+
| (RenderMode | keyof typeof RenderMode)
|
|
370
|
+
| PropertyBindingInfo
|
|
371
|
+
| `{${string}}`;
|
|
372
|
+
|
|
373
|
+
/**
|
|
374
|
+
* Specifies the fill and text color of the control. Accepts a number between 1 and 10 as a value. You can
|
|
375
|
+
* choose from 10 predefined background and text color combinations. The color schemes are non-semantic,
|
|
376
|
+
* you can select them according to your own preferences. **Note:** ColorScheme 10 is available only in
|
|
377
|
+
* Fiori 3 theme. The default `colorScheme` is 7.
|
|
378
|
+
*/
|
|
379
|
+
colorScheme?: int | PropertyBindingInfo | `{${string}}`;
|
|
380
|
+
|
|
381
|
+
/**
|
|
382
|
+
* Specifies the width of the `InfoLabel` control. By default, the `InfoLabel` control has the width of
|
|
383
|
+
* the content. Set this property to restrict the width to a custom value.
|
|
384
|
+
*/
|
|
385
|
+
width?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
386
|
+
|
|
387
|
+
/**
|
|
388
|
+
* Determines if the `InfoLabel` is in `displayOnly` mode. When set to `true` the control size adjusts to
|
|
389
|
+
* fit other controls, for example non-editable `Forms`.
|
|
390
|
+
*/
|
|
391
|
+
displayOnly?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
392
|
+
|
|
393
|
+
/**
|
|
394
|
+
* Available options for the text direction are LTR and RTL. By default the control inherits the text direction
|
|
395
|
+
* from its parent control.
|
|
396
|
+
*/
|
|
397
|
+
textDirection?:
|
|
398
|
+
| (TextDirection | keyof typeof TextDirection)
|
|
399
|
+
| PropertyBindingInfo
|
|
400
|
+
| `{${string}}`;
|
|
401
|
+
|
|
402
|
+
/**
|
|
403
|
+
* @SINCE 1.74
|
|
404
|
+
*
|
|
405
|
+
* Defines the icon to be displayed as graphical element within the `InfoLabel`. It can be an icon from
|
|
406
|
+
* the icon font.
|
|
407
|
+
*/
|
|
408
|
+
icon?: URI | PropertyBindingInfo | `{${string}}`;
|
|
409
|
+
}
|
|
410
|
+
}
|
|
411
|
+
|
|
412
|
+
declare module "sap/tnt/NavigationList" {
|
|
413
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
414
|
+
|
|
415
|
+
import { ID, CSSSize } from "sap/ui/core/library";
|
|
416
|
+
|
|
417
|
+
import NavigationListItem from "sap/tnt/NavigationListItem";
|
|
418
|
+
|
|
419
|
+
import Event from "sap/ui/base/Event";
|
|
420
|
+
|
|
421
|
+
import Item from "sap/ui/core/Item";
|
|
422
|
+
|
|
423
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
424
|
+
|
|
425
|
+
import {
|
|
426
|
+
PropertyBindingInfo,
|
|
427
|
+
AggregationBindingInfo,
|
|
428
|
+
} from "sap/ui/base/ManagedObject";
|
|
429
|
+
|
|
430
|
+
/**
|
|
431
|
+
* @SINCE 1.34
|
|
432
|
+
*
|
|
433
|
+
* The NavigationList control is an interactive control, which provides a choice of different items, ordered
|
|
434
|
+
* as a list.
|
|
435
|
+
*/
|
|
436
|
+
export default class NavigationList extends Control {
|
|
437
|
+
/**
|
|
438
|
+
* Constructor for a new NavigationList.
|
|
439
|
+
*
|
|
440
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
441
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
442
|
+
* of the syntax of the settings object.
|
|
443
|
+
*/
|
|
444
|
+
constructor(
|
|
445
|
+
/**
|
|
446
|
+
* Initial settings for the new control
|
|
447
|
+
*/
|
|
448
|
+
mSettings?: $NavigationListSettings
|
|
449
|
+
);
|
|
450
|
+
/**
|
|
451
|
+
* Constructor for a new NavigationList.
|
|
452
|
+
*
|
|
453
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
454
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
455
|
+
* of the syntax of the settings object.
|
|
456
|
+
*/
|
|
457
|
+
constructor(
|
|
458
|
+
/**
|
|
459
|
+
* ID for the new control, generated automatically if no ID is given
|
|
460
|
+
*/
|
|
461
|
+
sId?: string,
|
|
462
|
+
/**
|
|
463
|
+
* Initial settings for the new control
|
|
464
|
+
*/
|
|
465
|
+
mSettings?: $NavigationListSettings
|
|
466
|
+
);
|
|
467
|
+
|
|
468
|
+
/**
|
|
469
|
+
* Creates a new subclass of class sap.tnt.NavigationList with name `sClassName` and enriches it with the
|
|
470
|
+
* information contained in `oClassInfo`.
|
|
471
|
+
*
|
|
472
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
473
|
+
*
|
|
474
|
+
* @returns Created class / constructor function
|
|
475
|
+
*/
|
|
476
|
+
static extend<T extends Record<string, unknown>>(
|
|
477
|
+
/**
|
|
478
|
+
* Name of the class being created
|
|
479
|
+
*/
|
|
480
|
+
sClassName: string,
|
|
481
|
+
/**
|
|
482
|
+
* Object literal with information about the class
|
|
483
|
+
*/
|
|
484
|
+
oClassInfo?: sap.ClassInfo<T, NavigationList>,
|
|
485
|
+
/**
|
|
486
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
487
|
+
* used by this class
|
|
488
|
+
*/
|
|
489
|
+
FNMetaImpl?: Function
|
|
490
|
+
): Function;
|
|
491
|
+
/**
|
|
492
|
+
* Returns a metadata object for class sap.tnt.NavigationList.
|
|
493
|
+
*
|
|
494
|
+
* @returns Metadata object describing this class
|
|
495
|
+
*/
|
|
496
|
+
static getMetadata(): ElementMetadata;
|
|
497
|
+
/**
|
|
498
|
+
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
|
|
499
|
+
*
|
|
500
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
501
|
+
*/
|
|
502
|
+
addAriaDescribedBy(
|
|
503
|
+
/**
|
|
504
|
+
* The ariaDescribedBy to add; if empty, nothing is inserted
|
|
505
|
+
*/
|
|
506
|
+
vAriaDescribedBy: ID | Control
|
|
507
|
+
): this;
|
|
508
|
+
/**
|
|
509
|
+
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
|
|
510
|
+
*
|
|
511
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
512
|
+
*/
|
|
513
|
+
addAriaLabelledBy(
|
|
514
|
+
/**
|
|
515
|
+
* The ariaLabelledBy to add; if empty, nothing is inserted
|
|
516
|
+
*/
|
|
517
|
+
vAriaLabelledBy: ID | Control
|
|
518
|
+
): this;
|
|
519
|
+
/**
|
|
520
|
+
* Adds some item to the aggregation {@link #getItems items}.
|
|
521
|
+
*
|
|
522
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
523
|
+
*/
|
|
524
|
+
addItem(
|
|
525
|
+
/**
|
|
526
|
+
* The item to add; if empty, nothing is inserted
|
|
527
|
+
*/
|
|
528
|
+
oItem: NavigationListItem
|
|
529
|
+
): this;
|
|
530
|
+
/**
|
|
531
|
+
* Attaches event handler `fnFunction` to the {@link #event:itemSelect itemSelect} event of this `sap.tnt.NavigationList`.
|
|
532
|
+
*
|
|
533
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
534
|
+
* otherwise it will be bound to this `sap.tnt.NavigationList` itself.
|
|
535
|
+
*
|
|
536
|
+
* Fired when an item is selected.
|
|
537
|
+
*
|
|
538
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
539
|
+
*/
|
|
540
|
+
attachItemSelect(
|
|
541
|
+
/**
|
|
542
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
543
|
+
* object when firing the event
|
|
544
|
+
*/
|
|
545
|
+
oData: object,
|
|
546
|
+
/**
|
|
547
|
+
* The function to be called when the event occurs
|
|
548
|
+
*/
|
|
549
|
+
fnFunction: (p1: Event) => void,
|
|
550
|
+
/**
|
|
551
|
+
* Context object to call the event handler with. Defaults to this `sap.tnt.NavigationList` itself
|
|
552
|
+
*/
|
|
553
|
+
oListener?: object
|
|
554
|
+
): this;
|
|
555
|
+
/**
|
|
556
|
+
* Attaches event handler `fnFunction` to the {@link #event:itemSelect itemSelect} event of this `sap.tnt.NavigationList`.
|
|
557
|
+
*
|
|
558
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
559
|
+
* otherwise it will be bound to this `sap.tnt.NavigationList` itself.
|
|
560
|
+
*
|
|
561
|
+
* Fired when an item is selected.
|
|
562
|
+
*
|
|
563
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
564
|
+
*/
|
|
565
|
+
attachItemSelect(
|
|
566
|
+
/**
|
|
567
|
+
* The function to be called when the event occurs
|
|
568
|
+
*/
|
|
569
|
+
fnFunction: (p1: Event) => void,
|
|
570
|
+
/**
|
|
571
|
+
* Context object to call the event handler with. Defaults to this `sap.tnt.NavigationList` itself
|
|
572
|
+
*/
|
|
573
|
+
oListener?: object
|
|
574
|
+
): this;
|
|
575
|
+
/**
|
|
576
|
+
* Destroys all the items in the aggregation {@link #getItems items}.
|
|
577
|
+
*
|
|
578
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
579
|
+
*/
|
|
580
|
+
destroyItems(): this;
|
|
581
|
+
/**
|
|
582
|
+
* Detaches event handler `fnFunction` from the {@link #event:itemSelect itemSelect} event of this `sap.tnt.NavigationList`.
|
|
583
|
+
*
|
|
584
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
585
|
+
*
|
|
586
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
587
|
+
*/
|
|
588
|
+
detachItemSelect(
|
|
589
|
+
/**
|
|
590
|
+
* The function to be called, when the event occurs
|
|
591
|
+
*/
|
|
592
|
+
fnFunction: (p1: Event) => void,
|
|
593
|
+
/**
|
|
594
|
+
* Context object on which the given function had to be called
|
|
595
|
+
*/
|
|
596
|
+
oListener?: object
|
|
597
|
+
): this;
|
|
598
|
+
/**
|
|
599
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
600
|
+
*
|
|
601
|
+
* Fires event {@link #event:itemSelect itemSelect} to attached listeners.
|
|
602
|
+
*
|
|
603
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
604
|
+
*/
|
|
605
|
+
fireItemSelect(
|
|
606
|
+
/**
|
|
607
|
+
* Parameters to pass along with the event
|
|
608
|
+
*/
|
|
609
|
+
mParameters?: {
|
|
610
|
+
/**
|
|
611
|
+
* The selected item.
|
|
612
|
+
*/
|
|
613
|
+
item?: Item;
|
|
614
|
+
}
|
|
615
|
+
): this;
|
|
616
|
+
/**
|
|
617
|
+
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy
|
|
618
|
+
* ariaDescribedBy}.
|
|
619
|
+
*/
|
|
620
|
+
getAriaDescribedBy(): ID[];
|
|
621
|
+
/**
|
|
622
|
+
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy
|
|
623
|
+
* ariaLabelledBy}.
|
|
624
|
+
*/
|
|
625
|
+
getAriaLabelledBy(): ID[];
|
|
626
|
+
/**
|
|
627
|
+
* Gets current value of property {@link #getExpanded expanded}.
|
|
628
|
+
*
|
|
629
|
+
* Specifies if the control is in expanded or collapsed mode.
|
|
630
|
+
*
|
|
631
|
+
* Default value is `true`.
|
|
632
|
+
*
|
|
633
|
+
* @returns Value of property `expanded`
|
|
634
|
+
*/
|
|
635
|
+
getExpanded(): boolean;
|
|
636
|
+
/**
|
|
637
|
+
* Gets content of aggregation {@link #getItems items}.
|
|
638
|
+
*
|
|
639
|
+
* The items displayed in the list.
|
|
640
|
+
*/
|
|
641
|
+
getItems(): NavigationListItem[];
|
|
642
|
+
/**
|
|
643
|
+
* Gets the currently selected `NavigationListItem`.
|
|
644
|
+
*
|
|
645
|
+
* @returns The selected item or `null` if nothing is selected
|
|
646
|
+
*/
|
|
647
|
+
getSelectedItem(): NavigationListItem | null;
|
|
648
|
+
/**
|
|
649
|
+
* @SINCE 1.62.0
|
|
650
|
+
*
|
|
651
|
+
* Gets current value of property {@link #getSelectedKey selectedKey}.
|
|
652
|
+
*
|
|
653
|
+
* Specifies the currently selected key.
|
|
654
|
+
*
|
|
655
|
+
* @returns Value of property `selectedKey`
|
|
656
|
+
*/
|
|
657
|
+
getSelectedKey(): string;
|
|
658
|
+
/**
|
|
659
|
+
* Gets current value of property {@link #getWidth width}.
|
|
660
|
+
*
|
|
661
|
+
* Specifies the width of the control.
|
|
662
|
+
*
|
|
663
|
+
* @returns Value of property `width`
|
|
664
|
+
*/
|
|
665
|
+
getWidth(): CSSSize;
|
|
666
|
+
/**
|
|
667
|
+
* Checks for the provided `sap.tnt.NavigationListItem` in the aggregation {@link #getItems items}. and
|
|
668
|
+
* returns its index if found or -1 otherwise.
|
|
669
|
+
*
|
|
670
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
671
|
+
*/
|
|
672
|
+
indexOfItem(
|
|
673
|
+
/**
|
|
674
|
+
* The item whose index is looked for
|
|
675
|
+
*/
|
|
676
|
+
oItem: NavigationListItem
|
|
677
|
+
): int;
|
|
678
|
+
/**
|
|
679
|
+
* Inserts a item into the aggregation {@link #getItems items}.
|
|
680
|
+
*
|
|
681
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
682
|
+
*/
|
|
683
|
+
insertItem(
|
|
684
|
+
/**
|
|
685
|
+
* The item to insert; if empty, nothing is inserted
|
|
686
|
+
*/
|
|
687
|
+
oItem: NavigationListItem,
|
|
688
|
+
/**
|
|
689
|
+
* The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted
|
|
690
|
+
* at position 0; for a value greater than the current size of the aggregation, the item is inserted at
|
|
691
|
+
* the last position
|
|
692
|
+
*/
|
|
693
|
+
iIndex: int
|
|
694
|
+
): this;
|
|
695
|
+
/**
|
|
696
|
+
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
|
|
697
|
+
*
|
|
698
|
+
* @returns An array of the removed elements (might be empty)
|
|
699
|
+
*/
|
|
700
|
+
removeAllAriaDescribedBy(): ID[];
|
|
701
|
+
/**
|
|
702
|
+
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
|
|
703
|
+
*
|
|
704
|
+
* @returns An array of the removed elements (might be empty)
|
|
705
|
+
*/
|
|
706
|
+
removeAllAriaLabelledBy(): ID[];
|
|
707
|
+
/**
|
|
708
|
+
* Removes all the controls from the aggregation {@link #getItems items}.
|
|
709
|
+
*
|
|
710
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
711
|
+
*
|
|
712
|
+
* @returns An array of the removed elements (might be empty)
|
|
713
|
+
*/
|
|
714
|
+
removeAllItems(): NavigationListItem[];
|
|
715
|
+
/**
|
|
716
|
+
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
|
|
717
|
+
*
|
|
718
|
+
* @returns The removed ariaDescribedBy or `null`
|
|
719
|
+
*/
|
|
720
|
+
removeAriaDescribedBy(
|
|
721
|
+
/**
|
|
722
|
+
* The ariaDescribedBy to be removed or its index or ID
|
|
723
|
+
*/
|
|
724
|
+
vAriaDescribedBy: int | ID | Control
|
|
725
|
+
): ID | null;
|
|
726
|
+
/**
|
|
727
|
+
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
|
|
728
|
+
*
|
|
729
|
+
* @returns The removed ariaLabelledBy or `null`
|
|
730
|
+
*/
|
|
731
|
+
removeAriaLabelledBy(
|
|
732
|
+
/**
|
|
733
|
+
* The ariaLabelledBy to be removed or its index or ID
|
|
734
|
+
*/
|
|
735
|
+
vAriaLabelledBy: int | ID | Control
|
|
736
|
+
): ID | null;
|
|
737
|
+
/**
|
|
738
|
+
* Removes a item from the aggregation {@link #getItems items}.
|
|
739
|
+
*
|
|
740
|
+
* @returns The removed item or `null`
|
|
741
|
+
*/
|
|
742
|
+
removeItem(
|
|
743
|
+
/**
|
|
744
|
+
* The item to remove or its index or id
|
|
745
|
+
*/
|
|
746
|
+
vItem: int | string | NavigationListItem
|
|
747
|
+
): NavigationListItem | null;
|
|
748
|
+
/**
|
|
749
|
+
* Sets a new value for property {@link #getExpanded expanded}.
|
|
750
|
+
*
|
|
751
|
+
* Specifies if the control is in expanded or collapsed mode.
|
|
752
|
+
*
|
|
753
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
754
|
+
*
|
|
755
|
+
* Default value is `true`.
|
|
756
|
+
*
|
|
757
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
758
|
+
*/
|
|
759
|
+
setExpanded(
|
|
760
|
+
/**
|
|
761
|
+
* New value for property `expanded`
|
|
762
|
+
*/
|
|
763
|
+
bExpanded?: boolean
|
|
764
|
+
): this;
|
|
765
|
+
/**
|
|
766
|
+
* Sets the association for selectedItem. Set `null` to deselect.
|
|
767
|
+
*
|
|
768
|
+
* @returns The `selectedItem` association
|
|
769
|
+
*/
|
|
770
|
+
setSelectedItem(
|
|
771
|
+
/**
|
|
772
|
+
* The control to be set as selected
|
|
773
|
+
*/
|
|
774
|
+
selectedItem: string | NavigationListItem
|
|
775
|
+
): NavigationList | null;
|
|
776
|
+
/**
|
|
777
|
+
* Sets the selected item based on a key.
|
|
778
|
+
*
|
|
779
|
+
* @returns this pointer for chaining
|
|
780
|
+
*/
|
|
781
|
+
setSelectedKey(
|
|
782
|
+
/**
|
|
783
|
+
* The key of the item to be selected
|
|
784
|
+
*/
|
|
785
|
+
selectedKey: string
|
|
786
|
+
): this;
|
|
787
|
+
/**
|
|
788
|
+
* Sets a new value for property {@link #getWidth width}.
|
|
789
|
+
*
|
|
790
|
+
* Specifies the width of the control.
|
|
791
|
+
*
|
|
792
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
793
|
+
*
|
|
794
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
795
|
+
*/
|
|
796
|
+
setWidth(
|
|
797
|
+
/**
|
|
798
|
+
* New value for property `width`
|
|
799
|
+
*/
|
|
800
|
+
sWidth: CSSSize
|
|
801
|
+
): this;
|
|
802
|
+
}
|
|
803
|
+
|
|
804
|
+
export interface $NavigationListSettings extends $ControlSettings {
|
|
805
|
+
/**
|
|
806
|
+
* Specifies the width of the control.
|
|
807
|
+
*/
|
|
808
|
+
width?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
809
|
+
|
|
810
|
+
/**
|
|
811
|
+
* Specifies if the control is in expanded or collapsed mode.
|
|
812
|
+
*/
|
|
813
|
+
expanded?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
814
|
+
|
|
815
|
+
/**
|
|
816
|
+
* @SINCE 1.62.0
|
|
817
|
+
*
|
|
818
|
+
* Specifies the currently selected key.
|
|
819
|
+
*/
|
|
820
|
+
selectedKey?: string | PropertyBindingInfo;
|
|
821
|
+
|
|
822
|
+
/**
|
|
823
|
+
* The items displayed in the list.
|
|
824
|
+
*/
|
|
825
|
+
items?:
|
|
826
|
+
| NavigationListItem[]
|
|
827
|
+
| NavigationListItem
|
|
828
|
+
| AggregationBindingInfo
|
|
829
|
+
| `{${string}}`;
|
|
830
|
+
|
|
831
|
+
/**
|
|
832
|
+
* Association to controls / IDs, which describe this control (see WAI-ARIA attribute aria-describedby).
|
|
833
|
+
*/
|
|
834
|
+
ariaDescribedBy?: Array<Control | string>;
|
|
835
|
+
|
|
836
|
+
/**
|
|
837
|
+
* Association to controls / IDs, which label this control (see WAI-ARIA attribute aria-labelledby).
|
|
838
|
+
*/
|
|
839
|
+
ariaLabelledBy?: Array<Control | string>;
|
|
840
|
+
|
|
841
|
+
/**
|
|
842
|
+
* @SINCE 1.52.0
|
|
843
|
+
*
|
|
844
|
+
* The currently selected `NavigationListItem`.
|
|
845
|
+
*/
|
|
846
|
+
selectedItem?: NavigationListItem | string;
|
|
847
|
+
|
|
848
|
+
/**
|
|
849
|
+
* Fired when an item is selected.
|
|
850
|
+
*/
|
|
851
|
+
itemSelect?: (oEvent: Event) => void;
|
|
852
|
+
}
|
|
853
|
+
}
|
|
854
|
+
|
|
855
|
+
declare module "sap/tnt/NavigationListItem" {
|
|
856
|
+
import { default as Item, $ItemSettings } from "sap/ui/core/Item";
|
|
857
|
+
|
|
858
|
+
import Event from "sap/ui/base/Event";
|
|
859
|
+
|
|
860
|
+
import { URI } from "sap/ui/core/library";
|
|
861
|
+
|
|
862
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
863
|
+
|
|
864
|
+
import {
|
|
865
|
+
PropertyBindingInfo,
|
|
866
|
+
AggregationBindingInfo,
|
|
867
|
+
} from "sap/ui/base/ManagedObject";
|
|
868
|
+
|
|
869
|
+
/**
|
|
870
|
+
* @SINCE 1.34
|
|
871
|
+
*
|
|
872
|
+
* The NavigationListItem control represents an action, which can be selected by the user. It can provide
|
|
873
|
+
* sub items.
|
|
874
|
+
*/
|
|
875
|
+
export default class NavigationListItem extends Item {
|
|
876
|
+
/**
|
|
877
|
+
* Constructor for a new NavigationListItem.
|
|
878
|
+
*
|
|
879
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
880
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
881
|
+
* of the syntax of the settings object.
|
|
882
|
+
*/
|
|
883
|
+
constructor(
|
|
884
|
+
/**
|
|
885
|
+
* Initial settings for the new control
|
|
886
|
+
*/
|
|
887
|
+
mSettings?: $NavigationListItemSettings
|
|
888
|
+
);
|
|
889
|
+
/**
|
|
890
|
+
* Constructor for a new NavigationListItem.
|
|
891
|
+
*
|
|
892
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
893
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
894
|
+
* of the syntax of the settings object.
|
|
895
|
+
*/
|
|
896
|
+
constructor(
|
|
897
|
+
/**
|
|
898
|
+
* ID for the new control, generated automatically if no ID is given
|
|
899
|
+
*/
|
|
900
|
+
sId?: string,
|
|
901
|
+
/**
|
|
902
|
+
* Initial settings for the new control
|
|
903
|
+
*/
|
|
904
|
+
mSettings?: $NavigationListItemSettings
|
|
905
|
+
);
|
|
906
|
+
|
|
907
|
+
/**
|
|
908
|
+
* Creates a new subclass of class sap.tnt.NavigationListItem with name `sClassName` and enriches it with
|
|
909
|
+
* the information contained in `oClassInfo`.
|
|
910
|
+
*
|
|
911
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
|
|
912
|
+
*
|
|
913
|
+
* @returns Created class / constructor function
|
|
914
|
+
*/
|
|
915
|
+
static extend<T extends Record<string, unknown>>(
|
|
916
|
+
/**
|
|
917
|
+
* Name of the class being created
|
|
918
|
+
*/
|
|
919
|
+
sClassName: string,
|
|
920
|
+
/**
|
|
921
|
+
* Object literal with information about the class
|
|
922
|
+
*/
|
|
923
|
+
oClassInfo?: sap.ClassInfo<T, NavigationListItem>,
|
|
924
|
+
/**
|
|
925
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
926
|
+
* used by this class
|
|
927
|
+
*/
|
|
928
|
+
FNMetaImpl?: Function
|
|
929
|
+
): Function;
|
|
930
|
+
/**
|
|
931
|
+
* Returns a metadata object for class sap.tnt.NavigationListItem.
|
|
932
|
+
*
|
|
933
|
+
* @returns Metadata object describing this class
|
|
934
|
+
*/
|
|
935
|
+
static getMetadata(): ElementMetadata;
|
|
936
|
+
/**
|
|
937
|
+
* Adds some item to the aggregation {@link #getItems items}.
|
|
938
|
+
*
|
|
939
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
940
|
+
*/
|
|
941
|
+
addItem(
|
|
942
|
+
/**
|
|
943
|
+
* The item to add; if empty, nothing is inserted
|
|
944
|
+
*/
|
|
945
|
+
oItem: NavigationListItem
|
|
946
|
+
): this;
|
|
947
|
+
/**
|
|
948
|
+
* Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.tnt.NavigationListItem`.
|
|
949
|
+
*
|
|
950
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
951
|
+
* otherwise it will be bound to this `sap.tnt.NavigationListItem` itself.
|
|
952
|
+
*
|
|
953
|
+
* Fired when this item is selected.
|
|
954
|
+
*
|
|
955
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
956
|
+
*/
|
|
957
|
+
attachSelect(
|
|
958
|
+
/**
|
|
959
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
960
|
+
* object when firing the event
|
|
961
|
+
*/
|
|
962
|
+
oData: object,
|
|
963
|
+
/**
|
|
964
|
+
* The function to be called when the event occurs
|
|
965
|
+
*/
|
|
966
|
+
fnFunction: (p1: Event) => void,
|
|
967
|
+
/**
|
|
968
|
+
* Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItem` itself
|
|
969
|
+
*/
|
|
970
|
+
oListener?: object
|
|
971
|
+
): this;
|
|
972
|
+
/**
|
|
973
|
+
* Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.tnt.NavigationListItem`.
|
|
974
|
+
*
|
|
975
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
976
|
+
* otherwise it will be bound to this `sap.tnt.NavigationListItem` itself.
|
|
977
|
+
*
|
|
978
|
+
* Fired when this item is selected.
|
|
979
|
+
*
|
|
980
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
981
|
+
*/
|
|
982
|
+
attachSelect(
|
|
983
|
+
/**
|
|
984
|
+
* The function to be called when the event occurs
|
|
985
|
+
*/
|
|
986
|
+
fnFunction: (p1: Event) => void,
|
|
987
|
+
/**
|
|
988
|
+
* Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItem` itself
|
|
989
|
+
*/
|
|
990
|
+
oListener?: object
|
|
991
|
+
): this;
|
|
992
|
+
/**
|
|
993
|
+
* Destroys all the items in the aggregation {@link #getItems items}.
|
|
994
|
+
*
|
|
995
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
996
|
+
*/
|
|
997
|
+
destroyItems(): this;
|
|
998
|
+
/**
|
|
999
|
+
* Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.tnt.NavigationListItem`.
|
|
1000
|
+
*
|
|
1001
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
1002
|
+
*
|
|
1003
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1004
|
+
*/
|
|
1005
|
+
detachSelect(
|
|
1006
|
+
/**
|
|
1007
|
+
* The function to be called, when the event occurs
|
|
1008
|
+
*/
|
|
1009
|
+
fnFunction: (p1: Event) => void,
|
|
1010
|
+
/**
|
|
1011
|
+
* Context object on which the given function had to be called
|
|
1012
|
+
*/
|
|
1013
|
+
oListener?: object
|
|
1014
|
+
): this;
|
|
1015
|
+
/**
|
|
1016
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
1017
|
+
*
|
|
1018
|
+
* Fires event {@link #event:select select} to attached listeners.
|
|
1019
|
+
*
|
|
1020
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1021
|
+
*/
|
|
1022
|
+
fireSelect(
|
|
1023
|
+
/**
|
|
1024
|
+
* Parameters to pass along with the event
|
|
1025
|
+
*/
|
|
1026
|
+
mParameters?: {
|
|
1027
|
+
/**
|
|
1028
|
+
* The selected item.
|
|
1029
|
+
*/
|
|
1030
|
+
item?: Item;
|
|
1031
|
+
}
|
|
1032
|
+
): this;
|
|
1033
|
+
/**
|
|
1034
|
+
* Gets current value of property {@link #getExpanded expanded}.
|
|
1035
|
+
*
|
|
1036
|
+
* Specifies if the item is expanded.
|
|
1037
|
+
*
|
|
1038
|
+
* Default value is `true`.
|
|
1039
|
+
*
|
|
1040
|
+
* @returns Value of property `expanded`
|
|
1041
|
+
*/
|
|
1042
|
+
getExpanded(): boolean;
|
|
1043
|
+
/**
|
|
1044
|
+
* Gets current value of property {@link #getHasExpander hasExpander}.
|
|
1045
|
+
*
|
|
1046
|
+
* Specifies if the item has an expander.
|
|
1047
|
+
*
|
|
1048
|
+
* Default value is `true`.
|
|
1049
|
+
*
|
|
1050
|
+
* @returns Value of property `hasExpander`
|
|
1051
|
+
*/
|
|
1052
|
+
getHasExpander(): boolean;
|
|
1053
|
+
/**
|
|
1054
|
+
* Gets current value of property {@link #getHref href}.
|
|
1055
|
+
*
|
|
1056
|
+
* Defines the link target URI. Supports standard hyperlink behavior. If a JavaScript action should be triggered,
|
|
1057
|
+
* this should not be set, but instead an event handler for the `select` event should be registered.
|
|
1058
|
+
*
|
|
1059
|
+
* @returns Value of property `href`
|
|
1060
|
+
*/
|
|
1061
|
+
getHref(): URI;
|
|
1062
|
+
/**
|
|
1063
|
+
* Gets current value of property {@link #getIcon icon}.
|
|
1064
|
+
*
|
|
1065
|
+
* Specifies the icon for the item.
|
|
1066
|
+
*
|
|
1067
|
+
* Default value is `empty string`.
|
|
1068
|
+
*
|
|
1069
|
+
* @returns Value of property `icon`
|
|
1070
|
+
*/
|
|
1071
|
+
getIcon(): URI;
|
|
1072
|
+
/**
|
|
1073
|
+
* Gets content of aggregation {@link #getItems items}.
|
|
1074
|
+
*
|
|
1075
|
+
* The sub items.
|
|
1076
|
+
*/
|
|
1077
|
+
getItems(): NavigationListItem[];
|
|
1078
|
+
/**
|
|
1079
|
+
* Gets current value of property {@link #getTarget target}.
|
|
1080
|
+
*
|
|
1081
|
+
* Specifies the browsing context where the linked content will open.
|
|
1082
|
+
*
|
|
1083
|
+
* Options are the standard values for window.open() supported by browsers: `_self`, `_top`, `_blank`, `_parent`,
|
|
1084
|
+
* `_search`. Alternatively, a frame name can be entered. This property is only used when the `href` property
|
|
1085
|
+
* is set.
|
|
1086
|
+
*
|
|
1087
|
+
* @returns Value of property `target`
|
|
1088
|
+
*/
|
|
1089
|
+
getTarget(): string;
|
|
1090
|
+
/**
|
|
1091
|
+
* @SINCE 1.52
|
|
1092
|
+
*
|
|
1093
|
+
* Gets current value of property {@link #getVisible visible}.
|
|
1094
|
+
*
|
|
1095
|
+
* Specifies if the item should be shown.
|
|
1096
|
+
*
|
|
1097
|
+
* Default value is `true`.
|
|
1098
|
+
*
|
|
1099
|
+
* @returns Value of property `visible`
|
|
1100
|
+
*/
|
|
1101
|
+
getVisible(): boolean;
|
|
1102
|
+
/**
|
|
1103
|
+
* Checks for the provided `sap.tnt.NavigationListItem` in the aggregation {@link #getItems items}. and
|
|
1104
|
+
* returns its index if found or -1 otherwise.
|
|
1105
|
+
*
|
|
1106
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
1107
|
+
*/
|
|
1108
|
+
indexOfItem(
|
|
1109
|
+
/**
|
|
1110
|
+
* The item whose index is looked for
|
|
1111
|
+
*/
|
|
1112
|
+
oItem: NavigationListItem
|
|
1113
|
+
): int;
|
|
1114
|
+
/**
|
|
1115
|
+
* Inserts a item into the aggregation {@link #getItems items}.
|
|
1116
|
+
*
|
|
1117
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1118
|
+
*/
|
|
1119
|
+
insertItem(
|
|
1120
|
+
/**
|
|
1121
|
+
* The item to insert; if empty, nothing is inserted
|
|
1122
|
+
*/
|
|
1123
|
+
oItem: NavigationListItem,
|
|
1124
|
+
/**
|
|
1125
|
+
* The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted
|
|
1126
|
+
* at position 0; for a value greater than the current size of the aggregation, the item is inserted at
|
|
1127
|
+
* the last position
|
|
1128
|
+
*/
|
|
1129
|
+
iIndex: int
|
|
1130
|
+
): this;
|
|
1131
|
+
/**
|
|
1132
|
+
* Removes all the controls from the aggregation {@link #getItems items}.
|
|
1133
|
+
*
|
|
1134
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
1135
|
+
*
|
|
1136
|
+
* @returns An array of the removed elements (might be empty)
|
|
1137
|
+
*/
|
|
1138
|
+
removeAllItems(): NavigationListItem[];
|
|
1139
|
+
/**
|
|
1140
|
+
* Removes a item from the aggregation {@link #getItems items}.
|
|
1141
|
+
*
|
|
1142
|
+
* @returns The removed item or `null`
|
|
1143
|
+
*/
|
|
1144
|
+
removeItem(
|
|
1145
|
+
/**
|
|
1146
|
+
* The item to remove or its index or id
|
|
1147
|
+
*/
|
|
1148
|
+
vItem: int | string | NavigationListItem
|
|
1149
|
+
): NavigationListItem | null;
|
|
1150
|
+
/**
|
|
1151
|
+
* Sets a new value for property {@link #getExpanded expanded}.
|
|
1152
|
+
*
|
|
1153
|
+
* Specifies if the item is expanded.
|
|
1154
|
+
*
|
|
1155
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1156
|
+
*
|
|
1157
|
+
* Default value is `true`.
|
|
1158
|
+
*
|
|
1159
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1160
|
+
*/
|
|
1161
|
+
setExpanded(
|
|
1162
|
+
/**
|
|
1163
|
+
* New value for property `expanded`
|
|
1164
|
+
*/
|
|
1165
|
+
bExpanded?: boolean
|
|
1166
|
+
): this;
|
|
1167
|
+
/**
|
|
1168
|
+
* Sets a new value for property {@link #getHasExpander hasExpander}.
|
|
1169
|
+
*
|
|
1170
|
+
* Specifies if the item has an expander.
|
|
1171
|
+
*
|
|
1172
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1173
|
+
*
|
|
1174
|
+
* Default value is `true`.
|
|
1175
|
+
*
|
|
1176
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1177
|
+
*/
|
|
1178
|
+
setHasExpander(
|
|
1179
|
+
/**
|
|
1180
|
+
* New value for property `hasExpander`
|
|
1181
|
+
*/
|
|
1182
|
+
bHasExpander?: boolean
|
|
1183
|
+
): this;
|
|
1184
|
+
/**
|
|
1185
|
+
* Sets a new value for property {@link #getHref href}.
|
|
1186
|
+
*
|
|
1187
|
+
* Defines the link target URI. Supports standard hyperlink behavior. If a JavaScript action should be triggered,
|
|
1188
|
+
* this should not be set, but instead an event handler for the `select` event should be registered.
|
|
1189
|
+
*
|
|
1190
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1191
|
+
*
|
|
1192
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1193
|
+
*/
|
|
1194
|
+
setHref(
|
|
1195
|
+
/**
|
|
1196
|
+
* New value for property `href`
|
|
1197
|
+
*/
|
|
1198
|
+
sHref?: URI
|
|
1199
|
+
): this;
|
|
1200
|
+
/**
|
|
1201
|
+
* Sets a new value for property {@link #getIcon icon}.
|
|
1202
|
+
*
|
|
1203
|
+
* Specifies the icon for the item.
|
|
1204
|
+
*
|
|
1205
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1206
|
+
*
|
|
1207
|
+
* Default value is `empty string`.
|
|
1208
|
+
*
|
|
1209
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1210
|
+
*/
|
|
1211
|
+
setIcon(
|
|
1212
|
+
/**
|
|
1213
|
+
* New value for property `icon`
|
|
1214
|
+
*/
|
|
1215
|
+
sIcon?: URI
|
|
1216
|
+
): this;
|
|
1217
|
+
/**
|
|
1218
|
+
* Sets a new value for property {@link #getTarget target}.
|
|
1219
|
+
*
|
|
1220
|
+
* Specifies the browsing context where the linked content will open.
|
|
1221
|
+
*
|
|
1222
|
+
* Options are the standard values for window.open() supported by browsers: `_self`, `_top`, `_blank`, `_parent`,
|
|
1223
|
+
* `_search`. Alternatively, a frame name can be entered. This property is only used when the `href` property
|
|
1224
|
+
* is set.
|
|
1225
|
+
*
|
|
1226
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1227
|
+
*
|
|
1228
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1229
|
+
*/
|
|
1230
|
+
setTarget(
|
|
1231
|
+
/**
|
|
1232
|
+
* New value for property `target`
|
|
1233
|
+
*/
|
|
1234
|
+
sTarget?: string
|
|
1235
|
+
): this;
|
|
1236
|
+
/**
|
|
1237
|
+
* @SINCE 1.52
|
|
1238
|
+
*
|
|
1239
|
+
* Sets a new value for property {@link #getVisible visible}.
|
|
1240
|
+
*
|
|
1241
|
+
* Specifies if the item should be shown.
|
|
1242
|
+
*
|
|
1243
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1244
|
+
*
|
|
1245
|
+
* Default value is `true`.
|
|
1246
|
+
*
|
|
1247
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1248
|
+
*/
|
|
1249
|
+
setVisible(
|
|
1250
|
+
/**
|
|
1251
|
+
* New value for property `visible`
|
|
1252
|
+
*/
|
|
1253
|
+
bVisible?: boolean
|
|
1254
|
+
): this;
|
|
1255
|
+
}
|
|
1256
|
+
|
|
1257
|
+
export interface $NavigationListItemSettings extends $ItemSettings {
|
|
1258
|
+
/**
|
|
1259
|
+
* Specifies the icon for the item.
|
|
1260
|
+
*/
|
|
1261
|
+
icon?: URI | PropertyBindingInfo | `{${string}}`;
|
|
1262
|
+
|
|
1263
|
+
/**
|
|
1264
|
+
* Specifies if the item is expanded.
|
|
1265
|
+
*/
|
|
1266
|
+
expanded?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1267
|
+
|
|
1268
|
+
/**
|
|
1269
|
+
* Specifies if the item has an expander.
|
|
1270
|
+
*/
|
|
1271
|
+
hasExpander?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1272
|
+
|
|
1273
|
+
/**
|
|
1274
|
+
* @SINCE 1.52
|
|
1275
|
+
*
|
|
1276
|
+
* Specifies if the item should be shown.
|
|
1277
|
+
*/
|
|
1278
|
+
visible?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1279
|
+
|
|
1280
|
+
/**
|
|
1281
|
+
* Defines the link target URI. Supports standard hyperlink behavior. If a JavaScript action should be triggered,
|
|
1282
|
+
* this should not be set, but instead an event handler for the `select` event should be registered.
|
|
1283
|
+
*/
|
|
1284
|
+
href?: URI | PropertyBindingInfo | `{${string}}`;
|
|
1285
|
+
|
|
1286
|
+
/**
|
|
1287
|
+
* Specifies the browsing context where the linked content will open.
|
|
1288
|
+
*
|
|
1289
|
+
* Options are the standard values for window.open() supported by browsers: `_self`, `_top`, `_blank`, `_parent`,
|
|
1290
|
+
* `_search`. Alternatively, a frame name can be entered. This property is only used when the `href` property
|
|
1291
|
+
* is set.
|
|
1292
|
+
*/
|
|
1293
|
+
target?: string | PropertyBindingInfo;
|
|
1294
|
+
|
|
1295
|
+
/**
|
|
1296
|
+
* The sub items.
|
|
1297
|
+
*/
|
|
1298
|
+
items?:
|
|
1299
|
+
| NavigationListItem[]
|
|
1300
|
+
| NavigationListItem
|
|
1301
|
+
| AggregationBindingInfo
|
|
1302
|
+
| `{${string}}`;
|
|
1303
|
+
|
|
1304
|
+
/**
|
|
1305
|
+
* Fired when this item is selected.
|
|
1306
|
+
*/
|
|
1307
|
+
select?: (oEvent: Event) => void;
|
|
1308
|
+
}
|
|
1309
|
+
}
|
|
1310
|
+
|
|
1311
|
+
declare module "sap/tnt/SideNavigation" {
|
|
1312
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
1313
|
+
|
|
1314
|
+
import Event from "sap/ui/base/Event";
|
|
1315
|
+
|
|
1316
|
+
import {
|
|
1317
|
+
AggregationBindingInfo,
|
|
1318
|
+
PropertyBindingInfo,
|
|
1319
|
+
} from "sap/ui/base/ManagedObject";
|
|
1320
|
+
|
|
1321
|
+
import Item from "sap/ui/core/Item";
|
|
1322
|
+
|
|
1323
|
+
import NavigationList from "sap/tnt/NavigationList";
|
|
1324
|
+
|
|
1325
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
1326
|
+
|
|
1327
|
+
import { ID } from "sap/ui/core/library";
|
|
1328
|
+
|
|
1329
|
+
import NavigationListItem from "sap/tnt/NavigationListItem";
|
|
1330
|
+
|
|
1331
|
+
/**
|
|
1332
|
+
* @SINCE 1.34
|
|
1333
|
+
*
|
|
1334
|
+
* The SideNavigation control is a container, which consists of flexible and fixed parts on top of each
|
|
1335
|
+
* other. Responsive Behavior:
|
|
1336
|
+
* - The flexible part adapts its size to the fixed one.
|
|
1337
|
+
* - The flexible part has a scrollbar when the content is larger than the available space. **Note:**
|
|
1338
|
+
* In order for the SideNavigation to stretch properly, its parent layout control should only be the sap.tnt.ToolPage.
|
|
1339
|
+
*/
|
|
1340
|
+
export default class SideNavigation extends Control {
|
|
1341
|
+
/**
|
|
1342
|
+
* Constructor for a new SideNavigation.
|
|
1343
|
+
*
|
|
1344
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1345
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1346
|
+
* of the syntax of the settings object.
|
|
1347
|
+
* See:
|
|
1348
|
+
* {@link fiori:https://experience.sap.com/fiori-design-web/side-navigation/ Side Navigation}
|
|
1349
|
+
*/
|
|
1350
|
+
constructor(
|
|
1351
|
+
/**
|
|
1352
|
+
* Initial settings for the new control
|
|
1353
|
+
*/
|
|
1354
|
+
mSettings?: $SideNavigationSettings
|
|
1355
|
+
);
|
|
1356
|
+
/**
|
|
1357
|
+
* Constructor for a new SideNavigation.
|
|
1358
|
+
*
|
|
1359
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1360
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1361
|
+
* of the syntax of the settings object.
|
|
1362
|
+
* See:
|
|
1363
|
+
* {@link fiori:https://experience.sap.com/fiori-design-web/side-navigation/ Side Navigation}
|
|
1364
|
+
*/
|
|
1365
|
+
constructor(
|
|
1366
|
+
/**
|
|
1367
|
+
* ID for the new control, generated automatically if no ID is given
|
|
1368
|
+
*/
|
|
1369
|
+
sId?: string,
|
|
1370
|
+
/**
|
|
1371
|
+
* Initial settings for the new control
|
|
1372
|
+
*/
|
|
1373
|
+
mSettings?: $SideNavigationSettings
|
|
1374
|
+
);
|
|
1375
|
+
|
|
1376
|
+
/**
|
|
1377
|
+
* Creates a new subclass of class sap.tnt.SideNavigation with name `sClassName` and enriches it with the
|
|
1378
|
+
* information contained in `oClassInfo`.
|
|
1379
|
+
*
|
|
1380
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
1381
|
+
*
|
|
1382
|
+
* @returns Created class / constructor function
|
|
1383
|
+
*/
|
|
1384
|
+
static extend<T extends Record<string, unknown>>(
|
|
1385
|
+
/**
|
|
1386
|
+
* Name of the class being created
|
|
1387
|
+
*/
|
|
1388
|
+
sClassName: string,
|
|
1389
|
+
/**
|
|
1390
|
+
* Object literal with information about the class
|
|
1391
|
+
*/
|
|
1392
|
+
oClassInfo?: sap.ClassInfo<T, SideNavigation>,
|
|
1393
|
+
/**
|
|
1394
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1395
|
+
* used by this class
|
|
1396
|
+
*/
|
|
1397
|
+
FNMetaImpl?: Function
|
|
1398
|
+
): Function;
|
|
1399
|
+
/**
|
|
1400
|
+
* Returns a metadata object for class sap.tnt.SideNavigation.
|
|
1401
|
+
*
|
|
1402
|
+
* @returns Metadata object describing this class
|
|
1403
|
+
*/
|
|
1404
|
+
static getMetadata(): ElementMetadata;
|
|
1405
|
+
/**
|
|
1406
|
+
* Attaches event handler `fnFunction` to the {@link #event:itemSelect itemSelect} event of this `sap.tnt.SideNavigation`.
|
|
1407
|
+
*
|
|
1408
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
1409
|
+
* otherwise it will be bound to this `sap.tnt.SideNavigation` itself.
|
|
1410
|
+
*
|
|
1411
|
+
* Fired when an item is selected.
|
|
1412
|
+
*
|
|
1413
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1414
|
+
*/
|
|
1415
|
+
attachItemSelect(
|
|
1416
|
+
/**
|
|
1417
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
1418
|
+
* object when firing the event
|
|
1419
|
+
*/
|
|
1420
|
+
oData: object,
|
|
1421
|
+
/**
|
|
1422
|
+
* The function to be called when the event occurs
|
|
1423
|
+
*/
|
|
1424
|
+
fnFunction: (p1: Event) => void,
|
|
1425
|
+
/**
|
|
1426
|
+
* Context object to call the event handler with. Defaults to this `sap.tnt.SideNavigation` itself
|
|
1427
|
+
*/
|
|
1428
|
+
oListener?: object
|
|
1429
|
+
): this;
|
|
1430
|
+
/**
|
|
1431
|
+
* Attaches event handler `fnFunction` to the {@link #event:itemSelect itemSelect} event of this `sap.tnt.SideNavigation`.
|
|
1432
|
+
*
|
|
1433
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
1434
|
+
* otherwise it will be bound to this `sap.tnt.SideNavigation` itself.
|
|
1435
|
+
*
|
|
1436
|
+
* Fired when an item is selected.
|
|
1437
|
+
*
|
|
1438
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1439
|
+
*/
|
|
1440
|
+
attachItemSelect(
|
|
1441
|
+
/**
|
|
1442
|
+
* The function to be called when the event occurs
|
|
1443
|
+
*/
|
|
1444
|
+
fnFunction: (p1: Event) => void,
|
|
1445
|
+
/**
|
|
1446
|
+
* Context object to call the event handler with. Defaults to this `sap.tnt.SideNavigation` itself
|
|
1447
|
+
*/
|
|
1448
|
+
oListener?: object
|
|
1449
|
+
): this;
|
|
1450
|
+
/**
|
|
1451
|
+
* Binds aggregation {@link #getItem item} to model data.
|
|
1452
|
+
*
|
|
1453
|
+
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a detailed description
|
|
1454
|
+
* of the possible properties of `oBindingInfo`.
|
|
1455
|
+
*
|
|
1456
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1457
|
+
*/
|
|
1458
|
+
bindItem(
|
|
1459
|
+
/**
|
|
1460
|
+
* The binding information
|
|
1461
|
+
*/
|
|
1462
|
+
oBindingInfo: AggregationBindingInfo
|
|
1463
|
+
): this;
|
|
1464
|
+
/**
|
|
1465
|
+
* Destroys the fixedItem in the aggregation {@link #getFixedItem fixedItem}.
|
|
1466
|
+
*
|
|
1467
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1468
|
+
*/
|
|
1469
|
+
destroyFixedItem(): this;
|
|
1470
|
+
/**
|
|
1471
|
+
* Destroys the footer in the aggregation {@link #getFooter footer}.
|
|
1472
|
+
*
|
|
1473
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1474
|
+
*/
|
|
1475
|
+
destroyFooter(): this;
|
|
1476
|
+
/**
|
|
1477
|
+
* Destroys the item in the aggregation {@link #getItem item}.
|
|
1478
|
+
*
|
|
1479
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1480
|
+
*/
|
|
1481
|
+
destroyItem(): this;
|
|
1482
|
+
/**
|
|
1483
|
+
* Detaches event handler `fnFunction` from the {@link #event:itemSelect itemSelect} event of this `sap.tnt.SideNavigation`.
|
|
1484
|
+
*
|
|
1485
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
1486
|
+
*
|
|
1487
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1488
|
+
*/
|
|
1489
|
+
detachItemSelect(
|
|
1490
|
+
/**
|
|
1491
|
+
* The function to be called, when the event occurs
|
|
1492
|
+
*/
|
|
1493
|
+
fnFunction: (p1: Event) => void,
|
|
1494
|
+
/**
|
|
1495
|
+
* Context object on which the given function had to be called
|
|
1496
|
+
*/
|
|
1497
|
+
oListener?: object
|
|
1498
|
+
): this;
|
|
1499
|
+
/**
|
|
1500
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
1501
|
+
*
|
|
1502
|
+
* Fires event {@link #event:itemSelect itemSelect} to attached listeners.
|
|
1503
|
+
*
|
|
1504
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1505
|
+
*/
|
|
1506
|
+
fireItemSelect(
|
|
1507
|
+
/**
|
|
1508
|
+
* Parameters to pass along with the event
|
|
1509
|
+
*/
|
|
1510
|
+
mParameters?: {
|
|
1511
|
+
/**
|
|
1512
|
+
* The selected item.
|
|
1513
|
+
*/
|
|
1514
|
+
item?: Item;
|
|
1515
|
+
}
|
|
1516
|
+
): this;
|
|
1517
|
+
/**
|
|
1518
|
+
* @SINCE 1.98
|
|
1519
|
+
*
|
|
1520
|
+
* Gets current value of property {@link #getAriaLabel ariaLabel}.
|
|
1521
|
+
*
|
|
1522
|
+
* Specifies an optional aria-label that can be used by the screen readers.
|
|
1523
|
+
*
|
|
1524
|
+
* @returns Value of property `ariaLabel`
|
|
1525
|
+
*/
|
|
1526
|
+
getAriaLabel(): string;
|
|
1527
|
+
/**
|
|
1528
|
+
* Gets current value of property {@link #getExpanded expanded}.
|
|
1529
|
+
*
|
|
1530
|
+
* Specifies if the control is expanded.
|
|
1531
|
+
*
|
|
1532
|
+
* Default value is `true`.
|
|
1533
|
+
*
|
|
1534
|
+
* @returns Value of property `expanded`
|
|
1535
|
+
*/
|
|
1536
|
+
getExpanded(): boolean;
|
|
1537
|
+
/**
|
|
1538
|
+
* Gets content of aggregation {@link #getFixedItem fixedItem}.
|
|
1539
|
+
*
|
|
1540
|
+
* Defines the content inside the fixed part.
|
|
1541
|
+
*/
|
|
1542
|
+
getFixedItem(): NavigationList;
|
|
1543
|
+
/**
|
|
1544
|
+
* Gets content of aggregation {@link #getFooter footer}.
|
|
1545
|
+
*
|
|
1546
|
+
* Defines the content inside the footer.
|
|
1547
|
+
*/
|
|
1548
|
+
getFooter(): NavigationList;
|
|
1549
|
+
/**
|
|
1550
|
+
* Gets content of aggregation {@link #getItem item}.
|
|
1551
|
+
*
|
|
1552
|
+
* Defines the content inside the flexible part.
|
|
1553
|
+
*/
|
|
1554
|
+
getItem(): NavigationList;
|
|
1555
|
+
/**
|
|
1556
|
+
* @SINCE 1.52.0
|
|
1557
|
+
*
|
|
1558
|
+
* ID of the element which is the current target of the association {@link #getSelectedItem selectedItem},
|
|
1559
|
+
* or `null`.
|
|
1560
|
+
*/
|
|
1561
|
+
getSelectedItem(): ID;
|
|
1562
|
+
/**
|
|
1563
|
+
* @SINCE 1.62.0
|
|
1564
|
+
*
|
|
1565
|
+
* Gets current value of property {@link #getSelectedKey selectedKey}.
|
|
1566
|
+
*
|
|
1567
|
+
* Specifies the currently selected key.
|
|
1568
|
+
*
|
|
1569
|
+
* @returns Value of property `selectedKey`
|
|
1570
|
+
*/
|
|
1571
|
+
getSelectedKey(): string;
|
|
1572
|
+
/**
|
|
1573
|
+
* @SINCE 1.98
|
|
1574
|
+
*
|
|
1575
|
+
* Sets a new value for property {@link #getAriaLabel ariaLabel}.
|
|
1576
|
+
*
|
|
1577
|
+
* Specifies an optional aria-label that can be used by the screen readers.
|
|
1578
|
+
*
|
|
1579
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1580
|
+
*
|
|
1581
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1582
|
+
*/
|
|
1583
|
+
setAriaLabel(
|
|
1584
|
+
/**
|
|
1585
|
+
* New value for property `ariaLabel`
|
|
1586
|
+
*/
|
|
1587
|
+
sAriaLabel?: string
|
|
1588
|
+
): this;
|
|
1589
|
+
/**
|
|
1590
|
+
* Sets if the control is in expanded or collapsed mode.
|
|
1591
|
+
*
|
|
1592
|
+
* @returns this SideNavigation reference for chaining.
|
|
1593
|
+
*/
|
|
1594
|
+
setExpanded(
|
|
1595
|
+
/**
|
|
1596
|
+
* Indication if the SideNavigation is expanded.
|
|
1597
|
+
*/
|
|
1598
|
+
isExpanded: boolean
|
|
1599
|
+
): this;
|
|
1600
|
+
/**
|
|
1601
|
+
* Sets the aggregated {@link #getFixedItem fixedItem}.
|
|
1602
|
+
*
|
|
1603
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1604
|
+
*/
|
|
1605
|
+
setFixedItem(
|
|
1606
|
+
/**
|
|
1607
|
+
* The fixedItem to set
|
|
1608
|
+
*/
|
|
1609
|
+
oFixedItem: NavigationList
|
|
1610
|
+
): this;
|
|
1611
|
+
/**
|
|
1612
|
+
* Sets the aggregated {@link #getFooter footer}.
|
|
1613
|
+
*
|
|
1614
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1615
|
+
*/
|
|
1616
|
+
setFooter(
|
|
1617
|
+
/**
|
|
1618
|
+
* The footer to set
|
|
1619
|
+
*/
|
|
1620
|
+
oFooter: NavigationList
|
|
1621
|
+
): this;
|
|
1622
|
+
/**
|
|
1623
|
+
* Sets the aggregated {@link #getItem item}.
|
|
1624
|
+
*
|
|
1625
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1626
|
+
*/
|
|
1627
|
+
setItem(
|
|
1628
|
+
/**
|
|
1629
|
+
* The item to set
|
|
1630
|
+
*/
|
|
1631
|
+
oItem: NavigationList
|
|
1632
|
+
): this;
|
|
1633
|
+
/**
|
|
1634
|
+
* Sets the association for selectedItem
|
|
1635
|
+
*
|
|
1636
|
+
* @returns The `selectedItem` association
|
|
1637
|
+
*/
|
|
1638
|
+
setSelectedItem(
|
|
1639
|
+
/**
|
|
1640
|
+
* The control to be set as selected
|
|
1641
|
+
*/
|
|
1642
|
+
selectedItem: string | NavigationListItem
|
|
1643
|
+
): SideNavigation | null;
|
|
1644
|
+
/**
|
|
1645
|
+
* Sets the selected item based on a key.
|
|
1646
|
+
*
|
|
1647
|
+
* @returns this pointer for chaining
|
|
1648
|
+
*/
|
|
1649
|
+
setSelectedKey(
|
|
1650
|
+
/**
|
|
1651
|
+
* The key of the item to be selected
|
|
1652
|
+
*/
|
|
1653
|
+
selectedKey: string
|
|
1654
|
+
): this;
|
|
1655
|
+
/**
|
|
1656
|
+
* Unbinds aggregation {@link #getItem item} from model data.
|
|
1657
|
+
*
|
|
1658
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1659
|
+
*/
|
|
1660
|
+
unbindItem(): this;
|
|
1661
|
+
}
|
|
1662
|
+
|
|
1663
|
+
export interface $SideNavigationSettings extends $ControlSettings {
|
|
1664
|
+
/**
|
|
1665
|
+
* Specifies if the control is expanded.
|
|
1666
|
+
*/
|
|
1667
|
+
expanded?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1668
|
+
|
|
1669
|
+
/**
|
|
1670
|
+
* @SINCE 1.62.0
|
|
1671
|
+
*
|
|
1672
|
+
* Specifies the currently selected key.
|
|
1673
|
+
*/
|
|
1674
|
+
selectedKey?: string | PropertyBindingInfo;
|
|
1675
|
+
|
|
1676
|
+
/**
|
|
1677
|
+
* @SINCE 1.98
|
|
1678
|
+
*
|
|
1679
|
+
* Specifies an optional aria-label that can be used by the screen readers.
|
|
1680
|
+
*/
|
|
1681
|
+
ariaLabel?: string | PropertyBindingInfo;
|
|
1682
|
+
|
|
1683
|
+
/**
|
|
1684
|
+
* Defines the content inside the flexible part.
|
|
1685
|
+
*/
|
|
1686
|
+
item?: NavigationList;
|
|
1687
|
+
|
|
1688
|
+
/**
|
|
1689
|
+
* Defines the content inside the fixed part.
|
|
1690
|
+
*/
|
|
1691
|
+
fixedItem?: NavigationList;
|
|
1692
|
+
|
|
1693
|
+
/**
|
|
1694
|
+
* Defines the content inside the footer.
|
|
1695
|
+
*/
|
|
1696
|
+
footer?: NavigationList;
|
|
1697
|
+
|
|
1698
|
+
/**
|
|
1699
|
+
* @SINCE 1.52.0
|
|
1700
|
+
*
|
|
1701
|
+
* The selected `NavigationListItem`.
|
|
1702
|
+
*/
|
|
1703
|
+
selectedItem?: NavigationListItem | string;
|
|
1704
|
+
|
|
1705
|
+
/**
|
|
1706
|
+
* Fired when an item is selected.
|
|
1707
|
+
*/
|
|
1708
|
+
itemSelect?: (oEvent: Event) => void;
|
|
1709
|
+
}
|
|
1710
|
+
}
|
|
1711
|
+
|
|
1712
|
+
declare module "sap/tnt/ToolHeader" {
|
|
1713
|
+
import {
|
|
1714
|
+
default as OverflowToolbar,
|
|
1715
|
+
$OverflowToolbarSettings,
|
|
1716
|
+
} from "sap/m/OverflowToolbar";
|
|
1717
|
+
|
|
1718
|
+
import { IToolHeader } from "sap/tnt/library";
|
|
1719
|
+
|
|
1720
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
1721
|
+
|
|
1722
|
+
/**
|
|
1723
|
+
* @SINCE 1.34
|
|
1724
|
+
*
|
|
1725
|
+
* The ToolHeader control is a horizontal container that is most commonly used to display buttons, labels,
|
|
1726
|
+
* and other various input controls. Overview: The ToolHeader control is based on {@link sap.m.OverflowToolbar}.
|
|
1727
|
+
* It contains clearly structured menus of commands that are available across the various apps within the
|
|
1728
|
+
* same tool layout. Usage:
|
|
1729
|
+
* - If an app implements side navigation in addition to the tool header menu, the menu icon must be the
|
|
1730
|
+
* first item on the left-hand side of the tool header.
|
|
1731
|
+
* - The app menu and the side navigation must not have any dependencies and must work independently.
|
|
1732
|
+
* Fiori 3 theme specifics: In Fiori 3 Default theme the ToolHeader is with dark design unlike most
|
|
1733
|
+
* of the other controls. This defines the usage of limited controls inside it, which will result in good
|
|
1734
|
+
* design combination.
|
|
1735
|
+
* The ToolHeader stylizes the contained controls with the Shell color parameters, to match the dark design
|
|
1736
|
+
* requirement. However, that's not a dark theme.
|
|
1737
|
+
*
|
|
1738
|
+
* Only the following controls are supported: Control name Supported
|
|
1739
|
+
* Not supported sap.m.Text Single line text, text truncation Wrapping
|
|
1740
|
+
* sap.m.Title Single line text, text truncation. Consider using title headings
|
|
1741
|
+
* of H4, H5, H6. Wrapping sap.m.Label Single line text, text truncation
|
|
1742
|
+
* Wrapping sap.m.ObjectStatus Labels, semantic colors Indication
|
|
1743
|
+
* colors sap.ui.core.Icon sap.ui.core.IconColor enumeration for both icons
|
|
1744
|
+
* and backgrounds. Interaction state colors sap.m.Button Buttons
|
|
1745
|
+
* in their Back, Default, Transparent and Up types. All four types are over-styled to look as transparent
|
|
1746
|
+
* buttons. - sap.m.MenuButton Emphasized button type. Should be used
|
|
1747
|
+
* for triggering Mega menu. If there is no Mega menu, use Title (H6) instead.
|
|
1748
|
+
* Default (over-styled as Transparent) and Transparent types are used for standard menu representation.
|
|
1749
|
+
* - sap.m.Select Default and IconOnly types. IconOnly looks like a button
|
|
1750
|
+
* while Default looks is like an input. Semantic states sap.m.SearchField
|
|
1751
|
+
* Support for the regular state of the control. - sap.m.IconTabHeader
|
|
1752
|
+
* All background design variations (all are transparent). Text tab filters or text and count tab filters
|
|
1753
|
+
* in Inline mode only. Semantic colors, icons and separators. sap.f.Avatar/sap.m.Avatar
|
|
1754
|
+
* Support for default (Accent 6) color. Image avatar. - sap.m.Image
|
|
1755
|
+
* Primarily used for displaying the company logo. Interaction states
|
|
1756
|
+
*/
|
|
1757
|
+
export default class ToolHeader
|
|
1758
|
+
extends OverflowToolbar
|
|
1759
|
+
implements IToolHeader {
|
|
1760
|
+
__implements__sap_tnt_IToolHeader: boolean;
|
|
1761
|
+
/**
|
|
1762
|
+
* Constructor for a new ToolHeader.
|
|
1763
|
+
*
|
|
1764
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1765
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1766
|
+
* of the syntax of the settings object.
|
|
1767
|
+
*
|
|
1768
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.m.OverflowToolbar#constructor
|
|
1769
|
+
* sap.m.OverflowToolbar} can be used.
|
|
1770
|
+
* See:
|
|
1771
|
+
* {@link fiori:https://experience.sap.com/fiori-design-web/tool-header/ Tool Header}
|
|
1772
|
+
*/
|
|
1773
|
+
constructor(
|
|
1774
|
+
/**
|
|
1775
|
+
* Initial settings for the new control
|
|
1776
|
+
*/
|
|
1777
|
+
mSettings?: $ToolHeaderSettings
|
|
1778
|
+
);
|
|
1779
|
+
/**
|
|
1780
|
+
* Constructor for a new ToolHeader.
|
|
1781
|
+
*
|
|
1782
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1783
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1784
|
+
* of the syntax of the settings object.
|
|
1785
|
+
*
|
|
1786
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.m.OverflowToolbar#constructor
|
|
1787
|
+
* sap.m.OverflowToolbar} can be used.
|
|
1788
|
+
* See:
|
|
1789
|
+
* {@link fiori:https://experience.sap.com/fiori-design-web/tool-header/ Tool Header}
|
|
1790
|
+
*/
|
|
1791
|
+
constructor(
|
|
1792
|
+
/**
|
|
1793
|
+
* ID for the new control, generated automatically if no ID is given
|
|
1794
|
+
*/
|
|
1795
|
+
sId?: string,
|
|
1796
|
+
/**
|
|
1797
|
+
* Initial settings for the new control
|
|
1798
|
+
*/
|
|
1799
|
+
mSettings?: $ToolHeaderSettings
|
|
1800
|
+
);
|
|
1801
|
+
|
|
1802
|
+
/**
|
|
1803
|
+
* Creates a new subclass of class sap.tnt.ToolHeader with name `sClassName` and enriches it with the information
|
|
1804
|
+
* contained in `oClassInfo`.
|
|
1805
|
+
*
|
|
1806
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.m.OverflowToolbar.extend}.
|
|
1807
|
+
*
|
|
1808
|
+
* @returns Created class / constructor function
|
|
1809
|
+
*/
|
|
1810
|
+
static extend<T extends Record<string, unknown>>(
|
|
1811
|
+
/**
|
|
1812
|
+
* Name of the class being created
|
|
1813
|
+
*/
|
|
1814
|
+
sClassName: string,
|
|
1815
|
+
/**
|
|
1816
|
+
* Object literal with information about the class
|
|
1817
|
+
*/
|
|
1818
|
+
oClassInfo?: sap.ClassInfo<T, ToolHeader>,
|
|
1819
|
+
/**
|
|
1820
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1821
|
+
* used by this class
|
|
1822
|
+
*/
|
|
1823
|
+
FNMetaImpl?: Function
|
|
1824
|
+
): Function;
|
|
1825
|
+
/**
|
|
1826
|
+
* Returns a metadata object for class sap.tnt.ToolHeader.
|
|
1827
|
+
*
|
|
1828
|
+
* @returns Metadata object describing this class
|
|
1829
|
+
*/
|
|
1830
|
+
static getMetadata(): ElementMetadata;
|
|
1831
|
+
}
|
|
1832
|
+
|
|
1833
|
+
export interface $ToolHeaderSettings extends $OverflowToolbarSettings {}
|
|
1834
|
+
}
|
|
1835
|
+
|
|
1836
|
+
declare module "sap/tnt/ToolHeaderUtilitySeparator" {
|
|
1837
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
1838
|
+
|
|
1839
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
1840
|
+
|
|
1841
|
+
/**
|
|
1842
|
+
* @SINCE 1.16
|
|
1843
|
+
*
|
|
1844
|
+
* The ToolHeaderUtilitySeparator control is used in the sap.tnt.ToolHeader control to specify where the
|
|
1845
|
+
* overflow button is placed.
|
|
1846
|
+
*/
|
|
1847
|
+
export default class ToolHeaderUtilitySeparator extends Control {
|
|
1848
|
+
/**
|
|
1849
|
+
* Constructor for a new ToolHeaderUtilitySeparator.
|
|
1850
|
+
*
|
|
1851
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1852
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1853
|
+
* of the syntax of the settings object.
|
|
1854
|
+
*
|
|
1855
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor
|
|
1856
|
+
* sap.ui.core.Control} can be used.
|
|
1857
|
+
*/
|
|
1858
|
+
constructor(
|
|
1859
|
+
/**
|
|
1860
|
+
* Initial settings for the new control
|
|
1861
|
+
*/
|
|
1862
|
+
mSettings?: $ToolHeaderUtilitySeparatorSettings
|
|
1863
|
+
);
|
|
1864
|
+
/**
|
|
1865
|
+
* Constructor for a new ToolHeaderUtilitySeparator.
|
|
1866
|
+
*
|
|
1867
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1868
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1869
|
+
* of the syntax of the settings object.
|
|
1870
|
+
*
|
|
1871
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor
|
|
1872
|
+
* sap.ui.core.Control} can be used.
|
|
1873
|
+
*/
|
|
1874
|
+
constructor(
|
|
1875
|
+
/**
|
|
1876
|
+
* ID for the new control, generated automatically if no ID is given
|
|
1877
|
+
*/
|
|
1878
|
+
sId?: string,
|
|
1879
|
+
/**
|
|
1880
|
+
* Initial settings for the new control
|
|
1881
|
+
*/
|
|
1882
|
+
mSettings?: $ToolHeaderUtilitySeparatorSettings
|
|
1883
|
+
);
|
|
1884
|
+
|
|
1885
|
+
/**
|
|
1886
|
+
* Creates a new subclass of class sap.tnt.ToolHeaderUtilitySeparator with name `sClassName` and enriches
|
|
1887
|
+
* it with the information contained in `oClassInfo`.
|
|
1888
|
+
*
|
|
1889
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
1890
|
+
*
|
|
1891
|
+
* @returns Created class / constructor function
|
|
1892
|
+
*/
|
|
1893
|
+
static extend<T extends Record<string, unknown>>(
|
|
1894
|
+
/**
|
|
1895
|
+
* Name of the class being created
|
|
1896
|
+
*/
|
|
1897
|
+
sClassName: string,
|
|
1898
|
+
/**
|
|
1899
|
+
* Object literal with information about the class
|
|
1900
|
+
*/
|
|
1901
|
+
oClassInfo?: sap.ClassInfo<T, ToolHeaderUtilitySeparator>,
|
|
1902
|
+
/**
|
|
1903
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1904
|
+
* used by this class
|
|
1905
|
+
*/
|
|
1906
|
+
FNMetaImpl?: Function
|
|
1907
|
+
): Function;
|
|
1908
|
+
/**
|
|
1909
|
+
* Returns a metadata object for class sap.tnt.ToolHeaderUtilitySeparator.
|
|
1910
|
+
*
|
|
1911
|
+
* @returns Metadata object describing this class
|
|
1912
|
+
*/
|
|
1913
|
+
static getMetadata(): ElementMetadata;
|
|
1914
|
+
}
|
|
1915
|
+
|
|
1916
|
+
export interface $ToolHeaderUtilitySeparatorSettings
|
|
1917
|
+
extends $ControlSettings {}
|
|
1918
|
+
}
|
|
1919
|
+
|
|
1920
|
+
declare module "sap/tnt/ToolPage" {
|
|
1921
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
1922
|
+
|
|
1923
|
+
import { IToolHeader } from "sap/tnt/library";
|
|
1924
|
+
|
|
1925
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
1926
|
+
|
|
1927
|
+
import SideNavigation from "sap/tnt/SideNavigation";
|
|
1928
|
+
|
|
1929
|
+
import {
|
|
1930
|
+
PropertyBindingInfo,
|
|
1931
|
+
AggregationBindingInfo,
|
|
1932
|
+
} from "sap/ui/base/ManagedObject";
|
|
1933
|
+
|
|
1934
|
+
/**
|
|
1935
|
+
* @SINCE 1.34
|
|
1936
|
+
*
|
|
1937
|
+
* The ToolPage is a layout control, used to create a basic tools app that has a header, side navigation
|
|
1938
|
+
* and contents area. Overview: The control has three main areas - a header on top, navigation to the side
|
|
1939
|
+
* and a content area that can hold any control. The header and side navigation use custom controls - {@link
|
|
1940
|
+
* sap.tnt.ToolHeader} and {@link sap.tnt.SideNavigation}. Usage: The main usage of the sap.tnt controls
|
|
1941
|
+
* is for scenarios in the tooling or administration space.
|
|
1942
|
+
*/
|
|
1943
|
+
export default class ToolPage extends Control {
|
|
1944
|
+
/**
|
|
1945
|
+
* Constructor for a new ToolPage.
|
|
1946
|
+
*
|
|
1947
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1948
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1949
|
+
* of the syntax of the settings object.
|
|
1950
|
+
*/
|
|
1951
|
+
constructor(
|
|
1952
|
+
/**
|
|
1953
|
+
* Initial settings for the new control
|
|
1954
|
+
*/
|
|
1955
|
+
mSettings?: $ToolPageSettings
|
|
1956
|
+
);
|
|
1957
|
+
/**
|
|
1958
|
+
* Constructor for a new ToolPage.
|
|
1959
|
+
*
|
|
1960
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1961
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1962
|
+
* of the syntax of the settings object.
|
|
1963
|
+
*/
|
|
1964
|
+
constructor(
|
|
1965
|
+
/**
|
|
1966
|
+
* ID for the new control, generated automatically if no id is given
|
|
1967
|
+
*/
|
|
1968
|
+
sId?: string,
|
|
1969
|
+
/**
|
|
1970
|
+
* Initial settings for the new control
|
|
1971
|
+
*/
|
|
1972
|
+
mSettings?: $ToolPageSettings
|
|
1973
|
+
);
|
|
1974
|
+
|
|
1975
|
+
/**
|
|
1976
|
+
* Creates a new subclass of class sap.tnt.ToolPage with name `sClassName` and enriches it with the information
|
|
1977
|
+
* contained in `oClassInfo`.
|
|
1978
|
+
*
|
|
1979
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
1980
|
+
*
|
|
1981
|
+
* @returns Created class / constructor function
|
|
1982
|
+
*/
|
|
1983
|
+
static extend<T extends Record<string, unknown>>(
|
|
1984
|
+
/**
|
|
1985
|
+
* Name of the class being created
|
|
1986
|
+
*/
|
|
1987
|
+
sClassName: string,
|
|
1988
|
+
/**
|
|
1989
|
+
* Object literal with information about the class
|
|
1990
|
+
*/
|
|
1991
|
+
oClassInfo?: sap.ClassInfo<T, ToolPage>,
|
|
1992
|
+
/**
|
|
1993
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1994
|
+
* used by this class
|
|
1995
|
+
*/
|
|
1996
|
+
FNMetaImpl?: Function
|
|
1997
|
+
): Function;
|
|
1998
|
+
/**
|
|
1999
|
+
* Returns a metadata object for class sap.tnt.ToolPage.
|
|
2000
|
+
*
|
|
2001
|
+
* @returns Metadata object describing this class
|
|
2002
|
+
*/
|
|
2003
|
+
static getMetadata(): ElementMetadata;
|
|
2004
|
+
/**
|
|
2005
|
+
* Adds some mainContent to the aggregation {@link #getMainContents mainContents}.
|
|
2006
|
+
*
|
|
2007
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2008
|
+
*/
|
|
2009
|
+
addMainContent(
|
|
2010
|
+
/**
|
|
2011
|
+
* The mainContent to add; if empty, nothing is inserted
|
|
2012
|
+
*/
|
|
2013
|
+
oMainContent: Control
|
|
2014
|
+
): this;
|
|
2015
|
+
/**
|
|
2016
|
+
* Destroys the header in the aggregation {@link #getHeader header}.
|
|
2017
|
+
*
|
|
2018
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2019
|
+
*/
|
|
2020
|
+
destroyHeader(): this;
|
|
2021
|
+
/**
|
|
2022
|
+
* Destroys all the mainContents in the aggregation {@link #getMainContents mainContents}.
|
|
2023
|
+
*
|
|
2024
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2025
|
+
*/
|
|
2026
|
+
destroyMainContents(): this;
|
|
2027
|
+
/**
|
|
2028
|
+
* Destroys the sideContent in the aggregation {@link #getSideContent sideContent}.
|
|
2029
|
+
*
|
|
2030
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2031
|
+
*/
|
|
2032
|
+
destroySideContent(): this;
|
|
2033
|
+
/**
|
|
2034
|
+
* @SINCE 1.93
|
|
2035
|
+
*
|
|
2036
|
+
* Destroys the subHeader in the aggregation {@link #getSubHeader subHeader}.
|
|
2037
|
+
*
|
|
2038
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2039
|
+
*/
|
|
2040
|
+
destroySubHeader(): this;
|
|
2041
|
+
/**
|
|
2042
|
+
* Gets content of aggregation {@link #getHeader header}.
|
|
2043
|
+
*
|
|
2044
|
+
* The control to appear in the header area.
|
|
2045
|
+
*/
|
|
2046
|
+
getHeader(): IToolHeader;
|
|
2047
|
+
/**
|
|
2048
|
+
* Gets content of aggregation {@link #getMainContents mainContents}.
|
|
2049
|
+
*
|
|
2050
|
+
* The content section.
|
|
2051
|
+
*/
|
|
2052
|
+
getMainContents(): Control[];
|
|
2053
|
+
/**
|
|
2054
|
+
* Gets content of aggregation {@link #getSideContent sideContent}.
|
|
2055
|
+
*
|
|
2056
|
+
* The side menu of the layout.
|
|
2057
|
+
*/
|
|
2058
|
+
getSideContent(): SideNavigation;
|
|
2059
|
+
/**
|
|
2060
|
+
* Gets current value of property {@link #getSideExpanded sideExpanded}.
|
|
2061
|
+
*
|
|
2062
|
+
* Indicates if the side menu is expanded. Overrides the `expanded` property of the `sideContent` aggregation.
|
|
2063
|
+
*
|
|
2064
|
+
* Default value is `true`.
|
|
2065
|
+
*
|
|
2066
|
+
* @returns Value of property `sideExpanded`
|
|
2067
|
+
*/
|
|
2068
|
+
getSideExpanded(): boolean;
|
|
2069
|
+
/**
|
|
2070
|
+
* @SINCE 1.93
|
|
2071
|
+
*
|
|
2072
|
+
* Gets content of aggregation {@link #getSubHeader subHeader}.
|
|
2073
|
+
*
|
|
2074
|
+
* The control to appear in the subheader area.
|
|
2075
|
+
*/
|
|
2076
|
+
getSubHeader(): IToolHeader;
|
|
2077
|
+
/**
|
|
2078
|
+
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getMainContents mainContents}.
|
|
2079
|
+
* and returns its index if found or -1 otherwise.
|
|
2080
|
+
*
|
|
2081
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
2082
|
+
*/
|
|
2083
|
+
indexOfMainContent(
|
|
2084
|
+
/**
|
|
2085
|
+
* The mainContent whose index is looked for
|
|
2086
|
+
*/
|
|
2087
|
+
oMainContent: Control
|
|
2088
|
+
): int;
|
|
2089
|
+
/**
|
|
2090
|
+
* Inserts a mainContent into the aggregation {@link #getMainContents mainContents}.
|
|
2091
|
+
*
|
|
2092
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2093
|
+
*/
|
|
2094
|
+
insertMainContent(
|
|
2095
|
+
/**
|
|
2096
|
+
* The mainContent to insert; if empty, nothing is inserted
|
|
2097
|
+
*/
|
|
2098
|
+
oMainContent: Control,
|
|
2099
|
+
/**
|
|
2100
|
+
* The `0`-based index the mainContent should be inserted at; for a negative value of `iIndex`, the mainContent
|
|
2101
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the mainContent
|
|
2102
|
+
* is inserted at the last position
|
|
2103
|
+
*/
|
|
2104
|
+
iIndex: int
|
|
2105
|
+
): this;
|
|
2106
|
+
/**
|
|
2107
|
+
* Removes all the controls from the aggregation {@link #getMainContents mainContents}.
|
|
2108
|
+
*
|
|
2109
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
2110
|
+
*
|
|
2111
|
+
* @returns An array of the removed elements (might be empty)
|
|
2112
|
+
*/
|
|
2113
|
+
removeAllMainContents(): Control[];
|
|
2114
|
+
/**
|
|
2115
|
+
* Removes a mainContent from the aggregation {@link #getMainContents mainContents}.
|
|
2116
|
+
*
|
|
2117
|
+
* @returns The removed mainContent or `null`
|
|
2118
|
+
*/
|
|
2119
|
+
removeMainContent(
|
|
2120
|
+
/**
|
|
2121
|
+
* The mainContent to remove or its index or id
|
|
2122
|
+
*/
|
|
2123
|
+
vMainContent: int | string | Control
|
|
2124
|
+
): Control | null;
|
|
2125
|
+
/**
|
|
2126
|
+
* Sets the aggregated {@link #getHeader header}.
|
|
2127
|
+
*
|
|
2128
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2129
|
+
*/
|
|
2130
|
+
setHeader(
|
|
2131
|
+
/**
|
|
2132
|
+
* The header to set
|
|
2133
|
+
*/
|
|
2134
|
+
oHeader: IToolHeader
|
|
2135
|
+
): this;
|
|
2136
|
+
/**
|
|
2137
|
+
* Sets the aggregated {@link #getSideContent sideContent}.
|
|
2138
|
+
*
|
|
2139
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2140
|
+
*/
|
|
2141
|
+
setSideContent(
|
|
2142
|
+
/**
|
|
2143
|
+
* The sideContent to set
|
|
2144
|
+
*/
|
|
2145
|
+
oSideContent: SideNavigation
|
|
2146
|
+
): this;
|
|
2147
|
+
/**
|
|
2148
|
+
* Sets the expand/collapse state of the SideContent.
|
|
2149
|
+
*
|
|
2150
|
+
* @returns Pointer to the control instance for chaining
|
|
2151
|
+
*/
|
|
2152
|
+
setSideExpanded(
|
|
2153
|
+
/**
|
|
2154
|
+
* defines whether the SideNavigation is expanded.
|
|
2155
|
+
*/
|
|
2156
|
+
bSideExpanded: boolean
|
|
2157
|
+
): this;
|
|
2158
|
+
/**
|
|
2159
|
+
* @SINCE 1.93
|
|
2160
|
+
*
|
|
2161
|
+
* Sets the aggregated {@link #getSubHeader subHeader}.
|
|
2162
|
+
*
|
|
2163
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2164
|
+
*/
|
|
2165
|
+
setSubHeader(
|
|
2166
|
+
/**
|
|
2167
|
+
* The subHeader to set
|
|
2168
|
+
*/
|
|
2169
|
+
oSubHeader: IToolHeader
|
|
2170
|
+
): this;
|
|
2171
|
+
/**
|
|
2172
|
+
* Toggles the expand/collapse state of the SideContent.
|
|
2173
|
+
*
|
|
2174
|
+
* @returns Pointer to the control instance for chaining.
|
|
2175
|
+
*/
|
|
2176
|
+
toggleSideContentMode(): this;
|
|
2177
|
+
}
|
|
2178
|
+
|
|
2179
|
+
export interface $ToolPageSettings extends $ControlSettings {
|
|
2180
|
+
/**
|
|
2181
|
+
* Indicates if the side menu is expanded. Overrides the `expanded` property of the `sideContent` aggregation.
|
|
2182
|
+
*/
|
|
2183
|
+
sideExpanded?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
2184
|
+
|
|
2185
|
+
/**
|
|
2186
|
+
* The control to appear in the header area.
|
|
2187
|
+
*/
|
|
2188
|
+
header?: IToolHeader;
|
|
2189
|
+
|
|
2190
|
+
/**
|
|
2191
|
+
* @SINCE 1.93
|
|
2192
|
+
*
|
|
2193
|
+
* The control to appear in the subheader area.
|
|
2194
|
+
*/
|
|
2195
|
+
subHeader?: IToolHeader;
|
|
2196
|
+
|
|
2197
|
+
/**
|
|
2198
|
+
* The side menu of the layout.
|
|
2199
|
+
*/
|
|
2200
|
+
sideContent?: SideNavigation;
|
|
2201
|
+
|
|
2202
|
+
/**
|
|
2203
|
+
* The content section.
|
|
2204
|
+
*/
|
|
2205
|
+
mainContents?: Control[] | Control | AggregationBindingInfo | `{${string}}`;
|
|
2206
|
+
}
|
|
2207
|
+
}
|
|
2208
|
+
|
|
2209
|
+
declare namespace sap {
|
|
2210
|
+
interface IUI5DefineDependencyNames {
|
|
2211
|
+
"sap/tnt/InfoLabel": undefined;
|
|
2212
|
+
|
|
2213
|
+
"sap/tnt/library": undefined;
|
|
2214
|
+
|
|
2215
|
+
"sap/tnt/NavigationList": undefined;
|
|
2216
|
+
|
|
2217
|
+
"sap/tnt/NavigationListItem": undefined;
|
|
2218
|
+
|
|
2219
|
+
"sap/tnt/SideNavigation": undefined;
|
|
2220
|
+
|
|
2221
|
+
"sap/tnt/ToolHeader": undefined;
|
|
2222
|
+
|
|
2223
|
+
"sap/tnt/ToolHeaderUtilitySeparator": undefined;
|
|
2224
|
+
|
|
2225
|
+
"sap/tnt/ToolPage": undefined;
|
|
2226
|
+
}
|
|
2227
|
+
}
|