@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,3665 @@
|
|
|
1
|
+
// For Library Version: 1.113.0
|
|
2
|
+
|
|
3
|
+
declare module "sap/me/library" {
|
|
4
|
+
/**
|
|
5
|
+
* @deprecated (since 1.34)
|
|
6
|
+
* @EXPERIMENTAL (since 1.12) - API is not yet finished and might change completely
|
|
7
|
+
*
|
|
8
|
+
* Type of Design for the Calendar
|
|
9
|
+
*/
|
|
10
|
+
export enum CalendarDesign {
|
|
11
|
+
/**
|
|
12
|
+
* Colors match calendar design for Action
|
|
13
|
+
*/
|
|
14
|
+
Action = "Action",
|
|
15
|
+
/**
|
|
16
|
+
* Colors match calendar design for Approval
|
|
17
|
+
*/
|
|
18
|
+
Approval = "Approval",
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @deprecated (since 1.34)
|
|
22
|
+
* @EXPERIMENTAL (since 1.12) - API is not yet finished and might change completely
|
|
23
|
+
*
|
|
24
|
+
* Type code for a calendar event
|
|
25
|
+
*/
|
|
26
|
+
export enum CalendarEventType {
|
|
27
|
+
/**
|
|
28
|
+
* Type 00 (non-working day (e.g. weekend))
|
|
29
|
+
*/
|
|
30
|
+
Type00 = "Type00",
|
|
31
|
+
/**
|
|
32
|
+
* Type 01 (nonattendance / submitted day)
|
|
33
|
+
*/
|
|
34
|
+
Type01 = "Type01",
|
|
35
|
+
/**
|
|
36
|
+
* Type 04 (open request / manager action needed)
|
|
37
|
+
*/
|
|
38
|
+
Type04 = "Type04",
|
|
39
|
+
/**
|
|
40
|
+
* Type 06 (public holiday)
|
|
41
|
+
*/
|
|
42
|
+
Type06 = "Type06",
|
|
43
|
+
/**
|
|
44
|
+
* Type 07 (deletion requested / your action needed)
|
|
45
|
+
*/
|
|
46
|
+
Type07 = "Type07",
|
|
47
|
+
/**
|
|
48
|
+
* Type 10 (workday)
|
|
49
|
+
*/
|
|
50
|
+
Type10 = "Type10",
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* @deprecated (since 1.34)
|
|
54
|
+
* @EXPERIMENTAL (since 1.12) - API is not yet finished and might change completely
|
|
55
|
+
*
|
|
56
|
+
* Selection Mode for the Calendar
|
|
57
|
+
*/
|
|
58
|
+
export enum CalendarSelectionMode {
|
|
59
|
+
/**
|
|
60
|
+
* Can select multiple dates and ranges
|
|
61
|
+
*/
|
|
62
|
+
MULTIPLE = "MULTIPLE",
|
|
63
|
+
/**
|
|
64
|
+
* Can select a range of dates
|
|
65
|
+
*/
|
|
66
|
+
RANGE = "RANGE",
|
|
67
|
+
/**
|
|
68
|
+
* Can only select one date
|
|
69
|
+
*/
|
|
70
|
+
SINGLE = "SINGLE",
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
declare module "sap/me/Calendar" {
|
|
75
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
76
|
+
|
|
77
|
+
import Event from "sap/ui/base/Event";
|
|
78
|
+
|
|
79
|
+
import {
|
|
80
|
+
CalendarDesign,
|
|
81
|
+
CalendarSelectionMode,
|
|
82
|
+
CalendarEventType,
|
|
83
|
+
} from "sap/me/library";
|
|
84
|
+
|
|
85
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
86
|
+
|
|
87
|
+
import { CSSSize } from "sap/ui/core/library";
|
|
88
|
+
|
|
89
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
90
|
+
|
|
91
|
+
/**
|
|
92
|
+
* @deprecated (since 1.26.0) - This control was experimental since 1.12. Please use the sap.ui.unified.Calendar
|
|
93
|
+
* instead!
|
|
94
|
+
*
|
|
95
|
+
* This is the Calendar control
|
|
96
|
+
*/
|
|
97
|
+
export default class Calendar extends Control {
|
|
98
|
+
/**
|
|
99
|
+
* Constructor for a new Calendar.
|
|
100
|
+
*
|
|
101
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
102
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
103
|
+
* of the syntax of the settings object.
|
|
104
|
+
*/
|
|
105
|
+
constructor(
|
|
106
|
+
/**
|
|
107
|
+
* initial settings for the new control
|
|
108
|
+
*/
|
|
109
|
+
mSettings?: $CalendarSettings
|
|
110
|
+
);
|
|
111
|
+
/**
|
|
112
|
+
* Constructor for a new Calendar.
|
|
113
|
+
*
|
|
114
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
115
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
116
|
+
* of the syntax of the settings object.
|
|
117
|
+
*/
|
|
118
|
+
constructor(
|
|
119
|
+
/**
|
|
120
|
+
* id for the new control, generated automatically if no id is given
|
|
121
|
+
*/
|
|
122
|
+
sId?: string,
|
|
123
|
+
/**
|
|
124
|
+
* initial settings for the new control
|
|
125
|
+
*/
|
|
126
|
+
mSettings?: $CalendarSettings
|
|
127
|
+
);
|
|
128
|
+
|
|
129
|
+
/**
|
|
130
|
+
* Creates a new subclass of class sap.me.Calendar with name `sClassName` and enriches it with the information
|
|
131
|
+
* contained in `oClassInfo`.
|
|
132
|
+
*
|
|
133
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
134
|
+
*
|
|
135
|
+
* @returns Created class / constructor function
|
|
136
|
+
*/
|
|
137
|
+
static extend<T extends Record<string, unknown>>(
|
|
138
|
+
/**
|
|
139
|
+
* Name of the class being created
|
|
140
|
+
*/
|
|
141
|
+
sClassName: string,
|
|
142
|
+
/**
|
|
143
|
+
* Object literal with information about the class
|
|
144
|
+
*/
|
|
145
|
+
oClassInfo?: sap.ClassInfo<T, Calendar>,
|
|
146
|
+
/**
|
|
147
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
148
|
+
* used by this class
|
|
149
|
+
*/
|
|
150
|
+
FNMetaImpl?: Function
|
|
151
|
+
): Function;
|
|
152
|
+
/**
|
|
153
|
+
* Returns a metadata object for class sap.me.Calendar.
|
|
154
|
+
*
|
|
155
|
+
* @returns Metadata object describing this class
|
|
156
|
+
*/
|
|
157
|
+
static getMetadata(): ElementMetadata;
|
|
158
|
+
/**
|
|
159
|
+
* Helper function to instantiate a Date from the string(s) provided by the getCurrentDate, getSelectedDates
|
|
160
|
+
* methods. IMPORTANT: The only valid values for the created Date are: year, month, day. Disregard
|
|
161
|
+
* any other value: hours, minutes, seconds, milliseconds...
|
|
162
|
+
*
|
|
163
|
+
* @returns The Date, parsed from the input string.
|
|
164
|
+
*/
|
|
165
|
+
static parseDate(
|
|
166
|
+
/**
|
|
167
|
+
* The date, produced by a former call to Date.toDateString.
|
|
168
|
+
*/
|
|
169
|
+
strDate: string
|
|
170
|
+
): Date;
|
|
171
|
+
/**
|
|
172
|
+
* Attaches event handler `fnFunction` to the {@link #event:changeCurrentDate changeCurrentDate} event of
|
|
173
|
+
* this `sap.me.Calendar`.
|
|
174
|
+
*
|
|
175
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
176
|
+
* otherwise it will be bound to this `sap.me.Calendar` itself.
|
|
177
|
+
*
|
|
178
|
+
* event fired when tap to next or previous button and currentDate is updated
|
|
179
|
+
*
|
|
180
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
181
|
+
*/
|
|
182
|
+
attachChangeCurrentDate(
|
|
183
|
+
/**
|
|
184
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
185
|
+
* object when firing the event
|
|
186
|
+
*/
|
|
187
|
+
oData: object,
|
|
188
|
+
/**
|
|
189
|
+
* The function to be called when the event occurs
|
|
190
|
+
*/
|
|
191
|
+
fnFunction: (p1: Event) => void,
|
|
192
|
+
/**
|
|
193
|
+
* Context object to call the event handler with. Defaults to this `sap.me.Calendar` itself
|
|
194
|
+
*/
|
|
195
|
+
oListener?: object
|
|
196
|
+
): this;
|
|
197
|
+
/**
|
|
198
|
+
* Attaches event handler `fnFunction` to the {@link #event:changeCurrentDate changeCurrentDate} event of
|
|
199
|
+
* this `sap.me.Calendar`.
|
|
200
|
+
*
|
|
201
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
202
|
+
* otherwise it will be bound to this `sap.me.Calendar` itself.
|
|
203
|
+
*
|
|
204
|
+
* event fired when tap to next or previous button and currentDate is updated
|
|
205
|
+
*
|
|
206
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
207
|
+
*/
|
|
208
|
+
attachChangeCurrentDate(
|
|
209
|
+
/**
|
|
210
|
+
* The function to be called when the event occurs
|
|
211
|
+
*/
|
|
212
|
+
fnFunction: (p1: Event) => void,
|
|
213
|
+
/**
|
|
214
|
+
* Context object to call the event handler with. Defaults to this `sap.me.Calendar` itself
|
|
215
|
+
*/
|
|
216
|
+
oListener?: object
|
|
217
|
+
): this;
|
|
218
|
+
/**
|
|
219
|
+
* Attaches event handler `fnFunction` to the {@link #event:changeRange changeRange} event of this `sap.me.Calendar`.
|
|
220
|
+
*
|
|
221
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
222
|
+
* otherwise it will be bound to this `sap.me.Calendar` itself.
|
|
223
|
+
*
|
|
224
|
+
* when the range of selected dates changes
|
|
225
|
+
*
|
|
226
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
227
|
+
*/
|
|
228
|
+
attachChangeRange(
|
|
229
|
+
/**
|
|
230
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
231
|
+
* object when firing the event
|
|
232
|
+
*/
|
|
233
|
+
oData: object,
|
|
234
|
+
/**
|
|
235
|
+
* The function to be called when the event occurs
|
|
236
|
+
*/
|
|
237
|
+
fnFunction: (p1: Event) => void,
|
|
238
|
+
/**
|
|
239
|
+
* Context object to call the event handler with. Defaults to this `sap.me.Calendar` itself
|
|
240
|
+
*/
|
|
241
|
+
oListener?: object
|
|
242
|
+
): this;
|
|
243
|
+
/**
|
|
244
|
+
* Attaches event handler `fnFunction` to the {@link #event:changeRange changeRange} event of this `sap.me.Calendar`.
|
|
245
|
+
*
|
|
246
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
247
|
+
* otherwise it will be bound to this `sap.me.Calendar` itself.
|
|
248
|
+
*
|
|
249
|
+
* when the range of selected dates changes
|
|
250
|
+
*
|
|
251
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
252
|
+
*/
|
|
253
|
+
attachChangeRange(
|
|
254
|
+
/**
|
|
255
|
+
* The function to be called when the event occurs
|
|
256
|
+
*/
|
|
257
|
+
fnFunction: (p1: Event) => void,
|
|
258
|
+
/**
|
|
259
|
+
* Context object to call the event handler with. Defaults to this `sap.me.Calendar` itself
|
|
260
|
+
*/
|
|
261
|
+
oListener?: object
|
|
262
|
+
): this;
|
|
263
|
+
/**
|
|
264
|
+
* Attaches event handler `fnFunction` to the {@link #event:tapOnDate tapOnDate} event of this `sap.me.Calendar`.
|
|
265
|
+
*
|
|
266
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
267
|
+
* otherwise it will be bound to this `sap.me.Calendar` itself.
|
|
268
|
+
*
|
|
269
|
+
* event fired when a date is tapped
|
|
270
|
+
*
|
|
271
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
272
|
+
*/
|
|
273
|
+
attachTapOnDate(
|
|
274
|
+
/**
|
|
275
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
276
|
+
* object when firing the event
|
|
277
|
+
*/
|
|
278
|
+
oData: object,
|
|
279
|
+
/**
|
|
280
|
+
* The function to be called when the event occurs
|
|
281
|
+
*/
|
|
282
|
+
fnFunction: (p1: Event) => void,
|
|
283
|
+
/**
|
|
284
|
+
* Context object to call the event handler with. Defaults to this `sap.me.Calendar` itself
|
|
285
|
+
*/
|
|
286
|
+
oListener?: object
|
|
287
|
+
): this;
|
|
288
|
+
/**
|
|
289
|
+
* Attaches event handler `fnFunction` to the {@link #event:tapOnDate tapOnDate} event of this `sap.me.Calendar`.
|
|
290
|
+
*
|
|
291
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
292
|
+
* otherwise it will be bound to this `sap.me.Calendar` itself.
|
|
293
|
+
*
|
|
294
|
+
* event fired when a date is tapped
|
|
295
|
+
*
|
|
296
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
297
|
+
*/
|
|
298
|
+
attachTapOnDate(
|
|
299
|
+
/**
|
|
300
|
+
* The function to be called when the event occurs
|
|
301
|
+
*/
|
|
302
|
+
fnFunction: (p1: Event) => void,
|
|
303
|
+
/**
|
|
304
|
+
* Context object to call the event handler with. Defaults to this `sap.me.Calendar` itself
|
|
305
|
+
*/
|
|
306
|
+
oListener?: object
|
|
307
|
+
): this;
|
|
308
|
+
/**
|
|
309
|
+
* Detaches event handler `fnFunction` from the {@link #event:changeCurrentDate changeCurrentDate} event
|
|
310
|
+
* of this `sap.me.Calendar`.
|
|
311
|
+
*
|
|
312
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
313
|
+
*
|
|
314
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
315
|
+
*/
|
|
316
|
+
detachChangeCurrentDate(
|
|
317
|
+
/**
|
|
318
|
+
* The function to be called, when the event occurs
|
|
319
|
+
*/
|
|
320
|
+
fnFunction: (p1: Event) => void,
|
|
321
|
+
/**
|
|
322
|
+
* Context object on which the given function had to be called
|
|
323
|
+
*/
|
|
324
|
+
oListener?: object
|
|
325
|
+
): this;
|
|
326
|
+
/**
|
|
327
|
+
* Detaches event handler `fnFunction` from the {@link #event:changeRange changeRange} event of this `sap.me.Calendar`.
|
|
328
|
+
*
|
|
329
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
330
|
+
*
|
|
331
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
332
|
+
*/
|
|
333
|
+
detachChangeRange(
|
|
334
|
+
/**
|
|
335
|
+
* The function to be called, when the event occurs
|
|
336
|
+
*/
|
|
337
|
+
fnFunction: (p1: Event) => void,
|
|
338
|
+
/**
|
|
339
|
+
* Context object on which the given function had to be called
|
|
340
|
+
*/
|
|
341
|
+
oListener?: object
|
|
342
|
+
): this;
|
|
343
|
+
/**
|
|
344
|
+
* Detaches event handler `fnFunction` from the {@link #event:tapOnDate tapOnDate} event of this `sap.me.Calendar`.
|
|
345
|
+
*
|
|
346
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
347
|
+
*
|
|
348
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
349
|
+
*/
|
|
350
|
+
detachTapOnDate(
|
|
351
|
+
/**
|
|
352
|
+
* The function to be called, when the event occurs
|
|
353
|
+
*/
|
|
354
|
+
fnFunction: (p1: Event) => void,
|
|
355
|
+
/**
|
|
356
|
+
* Context object on which the given function had to be called
|
|
357
|
+
*/
|
|
358
|
+
oListener?: object
|
|
359
|
+
): this;
|
|
360
|
+
/**
|
|
361
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
362
|
+
*
|
|
363
|
+
* Fires event {@link #event:changeCurrentDate changeCurrentDate} to attached listeners.
|
|
364
|
+
*
|
|
365
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
366
|
+
*/
|
|
367
|
+
fireChangeCurrentDate(
|
|
368
|
+
/**
|
|
369
|
+
* Parameters to pass along with the event
|
|
370
|
+
*/
|
|
371
|
+
mParameters?: {
|
|
372
|
+
/**
|
|
373
|
+
* new date
|
|
374
|
+
*/
|
|
375
|
+
currentDate?: string;
|
|
376
|
+
}
|
|
377
|
+
): this;
|
|
378
|
+
/**
|
|
379
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
380
|
+
*
|
|
381
|
+
* Fires event {@link #event:changeRange changeRange} to attached listeners.
|
|
382
|
+
*
|
|
383
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
384
|
+
*/
|
|
385
|
+
fireChangeRange(
|
|
386
|
+
/**
|
|
387
|
+
* Parameters to pass along with the event
|
|
388
|
+
*/
|
|
389
|
+
mParameters?: {
|
|
390
|
+
/**
|
|
391
|
+
* from date
|
|
392
|
+
*/
|
|
393
|
+
fromDate?: string;
|
|
394
|
+
/**
|
|
395
|
+
* to date
|
|
396
|
+
*/
|
|
397
|
+
toDate?: string;
|
|
398
|
+
}
|
|
399
|
+
): this;
|
|
400
|
+
/**
|
|
401
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
402
|
+
*
|
|
403
|
+
* Fires event {@link #event:tapOnDate tapOnDate} to attached listeners.
|
|
404
|
+
*
|
|
405
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
406
|
+
*/
|
|
407
|
+
fireTapOnDate(
|
|
408
|
+
/**
|
|
409
|
+
* Parameters to pass along with the event
|
|
410
|
+
*/
|
|
411
|
+
mParameters?: {
|
|
412
|
+
/**
|
|
413
|
+
* date tapped
|
|
414
|
+
*/
|
|
415
|
+
date?: string;
|
|
416
|
+
/**
|
|
417
|
+
* if day was selected
|
|
418
|
+
*/
|
|
419
|
+
didSelect?: boolean;
|
|
420
|
+
}
|
|
421
|
+
): this;
|
|
422
|
+
/**
|
|
423
|
+
* Gets current value of property {@link #getCurrentDate currentDate}.
|
|
424
|
+
*
|
|
425
|
+
* the center date where the month/week will be built around
|
|
426
|
+
*
|
|
427
|
+
* @returns Value of property `currentDate`
|
|
428
|
+
*/
|
|
429
|
+
getCurrentDate(): string;
|
|
430
|
+
/**
|
|
431
|
+
* Gets current value of property {@link #getDayHeight dayHeight}.
|
|
432
|
+
*
|
|
433
|
+
* the height of a day
|
|
434
|
+
*
|
|
435
|
+
* Default value is `50`.
|
|
436
|
+
*
|
|
437
|
+
* @returns Value of property `dayHeight`
|
|
438
|
+
*/
|
|
439
|
+
getDayHeight(): int;
|
|
440
|
+
/**
|
|
441
|
+
* Gets current value of property {@link #getDays days}.
|
|
442
|
+
*
|
|
443
|
+
* Array of day names, default value is sap.m.getLocaleData().getDays("abbreviated") Check sap.ui.core.LocaleData
|
|
444
|
+
* documentation for more info.
|
|
445
|
+
*
|
|
446
|
+
* @returns Value of property `days`
|
|
447
|
+
*/
|
|
448
|
+
getDays(): any;
|
|
449
|
+
/**
|
|
450
|
+
* Gets current value of property {@link #getDayWidth dayWidth}.
|
|
451
|
+
*
|
|
452
|
+
* the width of a day
|
|
453
|
+
*
|
|
454
|
+
* Default value is `45`.
|
|
455
|
+
*
|
|
456
|
+
* @returns Value of property `dayWidth`
|
|
457
|
+
*/
|
|
458
|
+
getDayWidth(): int;
|
|
459
|
+
/**
|
|
460
|
+
* Gets current value of property {@link #getDesign design}.
|
|
461
|
+
*
|
|
462
|
+
* Indicates the design of the calendar (mainly colors)
|
|
463
|
+
*
|
|
464
|
+
* Default value is `Approval`.
|
|
465
|
+
*
|
|
466
|
+
* @returns Value of property `design`
|
|
467
|
+
*/
|
|
468
|
+
getDesign(): CalendarDesign | keyof typeof CalendarDesign;
|
|
469
|
+
/**
|
|
470
|
+
* Gets current value of property {@link #getDisabledDates disabledDates}.
|
|
471
|
+
*
|
|
472
|
+
* Array of specific dates (strings or Date objects) that will be disabled/non interactive
|
|
473
|
+
*
|
|
474
|
+
* @returns Value of property `disabledDates`
|
|
475
|
+
*/
|
|
476
|
+
getDisabledDates(): any;
|
|
477
|
+
/**
|
|
478
|
+
* Gets current value of property {@link #getDisabledWeekDays disabledWeekDays}.
|
|
479
|
+
*
|
|
480
|
+
* Array of weekDays (as integers where 0=Sunday, 1=Monday etc) to be disabled. Interaction will be disabled
|
|
481
|
+
* for these week days.
|
|
482
|
+
*
|
|
483
|
+
* @returns Value of property `disabledWeekDays`
|
|
484
|
+
*/
|
|
485
|
+
getDisabledWeekDays(): any;
|
|
486
|
+
/**
|
|
487
|
+
* Gets current value of property {@link #getEnableMultiselection enableMultiselection}.
|
|
488
|
+
*
|
|
489
|
+
* to enable multiselection feature
|
|
490
|
+
*
|
|
491
|
+
* Default value is `false`.
|
|
492
|
+
*
|
|
493
|
+
* @returns Value of property `enableMultiselection`
|
|
494
|
+
*/
|
|
495
|
+
getEnableMultiselection(): boolean;
|
|
496
|
+
/**
|
|
497
|
+
* Gets current value of property {@link #getFirstDayOffset firstDayOffset}.
|
|
498
|
+
*
|
|
499
|
+
* to offset the first day of the week (0 = sunday)
|
|
500
|
+
*
|
|
501
|
+
* Default value is `0`.
|
|
502
|
+
*
|
|
503
|
+
* @returns Value of property `firstDayOffset`
|
|
504
|
+
*/
|
|
505
|
+
getFirstDayOffset(): int;
|
|
506
|
+
/**
|
|
507
|
+
* Gets current value of property {@link #getHideMonthTitles hideMonthTitles}.
|
|
508
|
+
*
|
|
509
|
+
* hides the area of month titles
|
|
510
|
+
*
|
|
511
|
+
* Default value is `false`.
|
|
512
|
+
*
|
|
513
|
+
* @returns Value of property `hideMonthTitles`
|
|
514
|
+
*/
|
|
515
|
+
getHideMonthTitles(): boolean;
|
|
516
|
+
/**
|
|
517
|
+
* Gets current value of property {@link #getHideNavControls hideNavControls}.
|
|
518
|
+
*
|
|
519
|
+
* hides the area of navigation controls
|
|
520
|
+
*
|
|
521
|
+
* Default value is `false`.
|
|
522
|
+
*
|
|
523
|
+
* @returns Value of property `hideNavControls`
|
|
524
|
+
*/
|
|
525
|
+
getHideNavControls(): boolean;
|
|
526
|
+
/**
|
|
527
|
+
* Gets current value of property {@link #getMonths months}.
|
|
528
|
+
*
|
|
529
|
+
* Array of month names, default value is sap.m.getLocaleData().getMonths("abbreviated") Check sap.ui.core.LocaleData
|
|
530
|
+
* documentation for more info.
|
|
531
|
+
*
|
|
532
|
+
* @returns Value of property `months`
|
|
533
|
+
*/
|
|
534
|
+
getMonths(): any;
|
|
535
|
+
/**
|
|
536
|
+
* Gets current value of property {@link #getMonthsPerRow monthsPerRow}.
|
|
537
|
+
*
|
|
538
|
+
* months to display in a row. This sets the width of the whole control in order to contain the desired
|
|
539
|
+
* number of months per row
|
|
540
|
+
*
|
|
541
|
+
* Default value is `1`.
|
|
542
|
+
*
|
|
543
|
+
* @returns Value of property `monthsPerRow`
|
|
544
|
+
*/
|
|
545
|
+
getMonthsPerRow(): int;
|
|
546
|
+
/**
|
|
547
|
+
* Gets current value of property {@link #getMonthsToDisplay monthsToDisplay}.
|
|
548
|
+
*
|
|
549
|
+
* number of months in a row.
|
|
550
|
+
*
|
|
551
|
+
* Default value is `1`.
|
|
552
|
+
*
|
|
553
|
+
* @returns Value of property `monthsToDisplay`
|
|
554
|
+
*/
|
|
555
|
+
getMonthsToDisplay(): int;
|
|
556
|
+
/**
|
|
557
|
+
* returns an array of the currently selected dates (dates are strings formatted as Date.toDateString())
|
|
558
|
+
*/
|
|
559
|
+
getSelectedDates(): any;
|
|
560
|
+
/**
|
|
561
|
+
* Gets current value of property {@link #getSelectionMode selectionMode}.
|
|
562
|
+
*
|
|
563
|
+
* Indicates the design of the calendar (mainly colors)
|
|
564
|
+
*
|
|
565
|
+
* Default value is `SINGLE`.
|
|
566
|
+
*
|
|
567
|
+
* @returns Value of property `selectionMode`
|
|
568
|
+
*/
|
|
569
|
+
getSelectionMode():
|
|
570
|
+
| CalendarSelectionMode
|
|
571
|
+
| keyof typeof CalendarSelectionMode;
|
|
572
|
+
/**
|
|
573
|
+
* Gets current value of property {@link #getSingleRow singleRow}.
|
|
574
|
+
*
|
|
575
|
+
* boolean that sets the view to week mode or month mode
|
|
576
|
+
*
|
|
577
|
+
* @returns Value of property `singleRow`
|
|
578
|
+
*/
|
|
579
|
+
getSingleRow(): boolean;
|
|
580
|
+
/**
|
|
581
|
+
* Gets current value of property {@link #getSwipeToNavigate swipeToNavigate}.
|
|
582
|
+
*
|
|
583
|
+
* When enabled, swipe gestures will navigate and not select
|
|
584
|
+
*
|
|
585
|
+
* Default value is `false`.
|
|
586
|
+
*
|
|
587
|
+
* @returns Value of property `swipeToNavigate`
|
|
588
|
+
*/
|
|
589
|
+
getSwipeToNavigate(): boolean;
|
|
590
|
+
/**
|
|
591
|
+
* Gets current value of property {@link #getVisible visible}.
|
|
592
|
+
*
|
|
593
|
+
* visibility of the control
|
|
594
|
+
*
|
|
595
|
+
* Default value is `true`.
|
|
596
|
+
*
|
|
597
|
+
* @returns Value of property `visible`
|
|
598
|
+
*/
|
|
599
|
+
getVisible(): boolean;
|
|
600
|
+
/**
|
|
601
|
+
* Gets current value of property {@link #getWeeksPerRow weeksPerRow}.
|
|
602
|
+
*
|
|
603
|
+
* weeks to display in a row
|
|
604
|
+
*
|
|
605
|
+
* Default value is `1`.
|
|
606
|
+
*
|
|
607
|
+
* @returns Value of property `weeksPerRow`
|
|
608
|
+
*/
|
|
609
|
+
getWeeksPerRow(): int;
|
|
610
|
+
/**
|
|
611
|
+
* Gets current value of property {@link #getWidth width}.
|
|
612
|
+
*
|
|
613
|
+
* The width of the calendar
|
|
614
|
+
*
|
|
615
|
+
* Default value is `'100%'`.
|
|
616
|
+
*
|
|
617
|
+
* @returns Value of property `width`
|
|
618
|
+
*/
|
|
619
|
+
getWidth(): CSSSize;
|
|
620
|
+
/**
|
|
621
|
+
* Sets the current date of the calendar.
|
|
622
|
+
*
|
|
623
|
+
* @returns `this` to allow method chaining.
|
|
624
|
+
*/
|
|
625
|
+
setCurrentDate(
|
|
626
|
+
/**
|
|
627
|
+
* The Date to set, the format being identical to a date string produced by "toDateString".
|
|
628
|
+
*/
|
|
629
|
+
strDate: string
|
|
630
|
+
): this;
|
|
631
|
+
/**
|
|
632
|
+
* Sets a new value for property {@link #getDayHeight dayHeight}.
|
|
633
|
+
*
|
|
634
|
+
* the height of a day
|
|
635
|
+
*
|
|
636
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
637
|
+
*
|
|
638
|
+
* Default value is `50`.
|
|
639
|
+
*
|
|
640
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
641
|
+
*/
|
|
642
|
+
setDayHeight(
|
|
643
|
+
/**
|
|
644
|
+
* New value for property `dayHeight`
|
|
645
|
+
*/
|
|
646
|
+
iDayHeight?: int
|
|
647
|
+
): this;
|
|
648
|
+
/**
|
|
649
|
+
* Sets a new value for property {@link #getDays days}.
|
|
650
|
+
*
|
|
651
|
+
* Array of day names, default value is sap.m.getLocaleData().getDays("abbreviated") Check sap.ui.core.LocaleData
|
|
652
|
+
* documentation for more info.
|
|
653
|
+
*
|
|
654
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
655
|
+
*
|
|
656
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
657
|
+
*/
|
|
658
|
+
setDays(
|
|
659
|
+
/**
|
|
660
|
+
* New value for property `days`
|
|
661
|
+
*/
|
|
662
|
+
oDays?: any
|
|
663
|
+
): this;
|
|
664
|
+
/**
|
|
665
|
+
* Sets a new value for property {@link #getDayWidth dayWidth}.
|
|
666
|
+
*
|
|
667
|
+
* the width of a day
|
|
668
|
+
*
|
|
669
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
670
|
+
*
|
|
671
|
+
* Default value is `45`.
|
|
672
|
+
*
|
|
673
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
674
|
+
*/
|
|
675
|
+
setDayWidth(
|
|
676
|
+
/**
|
|
677
|
+
* New value for property `dayWidth`
|
|
678
|
+
*/
|
|
679
|
+
iDayWidth?: int
|
|
680
|
+
): this;
|
|
681
|
+
/**
|
|
682
|
+
* Sets a new value for property {@link #getDesign design}.
|
|
683
|
+
*
|
|
684
|
+
* Indicates the design of the calendar (mainly colors)
|
|
685
|
+
*
|
|
686
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
687
|
+
*
|
|
688
|
+
* Default value is `Approval`.
|
|
689
|
+
*
|
|
690
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
691
|
+
*/
|
|
692
|
+
setDesign(
|
|
693
|
+
/**
|
|
694
|
+
* New value for property `design`
|
|
695
|
+
*/
|
|
696
|
+
sDesign?: CalendarDesign | keyof typeof CalendarDesign
|
|
697
|
+
): this;
|
|
698
|
+
/**
|
|
699
|
+
* Sets a new value for property {@link #getDisabledDates disabledDates}.
|
|
700
|
+
*
|
|
701
|
+
* Array of specific dates (strings or Date objects) that will be disabled/non interactive
|
|
702
|
+
*
|
|
703
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
704
|
+
*
|
|
705
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
706
|
+
*/
|
|
707
|
+
setDisabledDates(
|
|
708
|
+
/**
|
|
709
|
+
* New value for property `disabledDates`
|
|
710
|
+
*/
|
|
711
|
+
oDisabledDates?: any
|
|
712
|
+
): this;
|
|
713
|
+
/**
|
|
714
|
+
* Sets a new value for property {@link #getDisabledWeekDays disabledWeekDays}.
|
|
715
|
+
*
|
|
716
|
+
* Array of weekDays (as integers where 0=Sunday, 1=Monday etc) to be disabled. Interaction will be disabled
|
|
717
|
+
* for these week days.
|
|
718
|
+
*
|
|
719
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
720
|
+
*
|
|
721
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
722
|
+
*/
|
|
723
|
+
setDisabledWeekDays(
|
|
724
|
+
/**
|
|
725
|
+
* New value for property `disabledWeekDays`
|
|
726
|
+
*/
|
|
727
|
+
oDisabledWeekDays?: any
|
|
728
|
+
): this;
|
|
729
|
+
/**
|
|
730
|
+
* Sets a new value for property {@link #getEnableMultiselection enableMultiselection}.
|
|
731
|
+
*
|
|
732
|
+
* to enable multiselection feature
|
|
733
|
+
*
|
|
734
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
735
|
+
*
|
|
736
|
+
* Default value is `false`.
|
|
737
|
+
*
|
|
738
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
739
|
+
*/
|
|
740
|
+
setEnableMultiselection(
|
|
741
|
+
/**
|
|
742
|
+
* New value for property `enableMultiselection`
|
|
743
|
+
*/
|
|
744
|
+
bEnableMultiselection?: boolean
|
|
745
|
+
): this;
|
|
746
|
+
/**
|
|
747
|
+
* Sets a new value for property {@link #getFirstDayOffset firstDayOffset}.
|
|
748
|
+
*
|
|
749
|
+
* to offset the first day of the week (0 = sunday)
|
|
750
|
+
*
|
|
751
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
752
|
+
*
|
|
753
|
+
* Default value is `0`.
|
|
754
|
+
*
|
|
755
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
756
|
+
*/
|
|
757
|
+
setFirstDayOffset(
|
|
758
|
+
/**
|
|
759
|
+
* New value for property `firstDayOffset`
|
|
760
|
+
*/
|
|
761
|
+
iFirstDayOffset?: int
|
|
762
|
+
): this;
|
|
763
|
+
/**
|
|
764
|
+
* Sets a new value for property {@link #getHideMonthTitles hideMonthTitles}.
|
|
765
|
+
*
|
|
766
|
+
* hides the area of month titles
|
|
767
|
+
*
|
|
768
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
769
|
+
*
|
|
770
|
+
* Default value is `false`.
|
|
771
|
+
*
|
|
772
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
773
|
+
*/
|
|
774
|
+
setHideMonthTitles(
|
|
775
|
+
/**
|
|
776
|
+
* New value for property `hideMonthTitles`
|
|
777
|
+
*/
|
|
778
|
+
bHideMonthTitles?: boolean
|
|
779
|
+
): this;
|
|
780
|
+
/**
|
|
781
|
+
* Sets a new value for property {@link #getHideNavControls hideNavControls}.
|
|
782
|
+
*
|
|
783
|
+
* hides the area of navigation controls
|
|
784
|
+
*
|
|
785
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
786
|
+
*
|
|
787
|
+
* Default value is `false`.
|
|
788
|
+
*
|
|
789
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
790
|
+
*/
|
|
791
|
+
setHideNavControls(
|
|
792
|
+
/**
|
|
793
|
+
* New value for property `hideNavControls`
|
|
794
|
+
*/
|
|
795
|
+
bHideNavControls?: boolean
|
|
796
|
+
): this;
|
|
797
|
+
/**
|
|
798
|
+
* Sets a new value for property {@link #getMonths months}.
|
|
799
|
+
*
|
|
800
|
+
* Array of month names, default value is sap.m.getLocaleData().getMonths("abbreviated") Check sap.ui.core.LocaleData
|
|
801
|
+
* documentation for more info.
|
|
802
|
+
*
|
|
803
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
804
|
+
*
|
|
805
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
806
|
+
*/
|
|
807
|
+
setMonths(
|
|
808
|
+
/**
|
|
809
|
+
* New value for property `months`
|
|
810
|
+
*/
|
|
811
|
+
oMonths?: any
|
|
812
|
+
): this;
|
|
813
|
+
/**
|
|
814
|
+
* Sets a new value for property {@link #getMonthsPerRow monthsPerRow}.
|
|
815
|
+
*
|
|
816
|
+
* months to display in a row. This sets the width of the whole control in order to contain the desired
|
|
817
|
+
* number of months per row
|
|
818
|
+
*
|
|
819
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
820
|
+
*
|
|
821
|
+
* Default value is `1`.
|
|
822
|
+
*
|
|
823
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
824
|
+
*/
|
|
825
|
+
setMonthsPerRow(
|
|
826
|
+
/**
|
|
827
|
+
* New value for property `monthsPerRow`
|
|
828
|
+
*/
|
|
829
|
+
iMonthsPerRow?: int
|
|
830
|
+
): this;
|
|
831
|
+
/**
|
|
832
|
+
* Sets a new value for property {@link #getMonthsToDisplay monthsToDisplay}.
|
|
833
|
+
*
|
|
834
|
+
* number of months in a row.
|
|
835
|
+
*
|
|
836
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
837
|
+
*
|
|
838
|
+
* Default value is `1`.
|
|
839
|
+
*
|
|
840
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
841
|
+
*/
|
|
842
|
+
setMonthsToDisplay(
|
|
843
|
+
/**
|
|
844
|
+
* New value for property `monthsToDisplay`
|
|
845
|
+
*/
|
|
846
|
+
iMonthsToDisplay?: int
|
|
847
|
+
): this;
|
|
848
|
+
/**
|
|
849
|
+
* Sets a new value for property {@link #getSelectionMode selectionMode}.
|
|
850
|
+
*
|
|
851
|
+
* Indicates the design of the calendar (mainly colors)
|
|
852
|
+
*
|
|
853
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
854
|
+
*
|
|
855
|
+
* Default value is `SINGLE`.
|
|
856
|
+
*
|
|
857
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
858
|
+
*/
|
|
859
|
+
setSelectionMode(
|
|
860
|
+
/**
|
|
861
|
+
* New value for property `selectionMode`
|
|
862
|
+
*/
|
|
863
|
+
sSelectionMode?:
|
|
864
|
+
| CalendarSelectionMode
|
|
865
|
+
| keyof typeof CalendarSelectionMode
|
|
866
|
+
): this;
|
|
867
|
+
/**
|
|
868
|
+
* Sets a new value for property {@link #getSingleRow singleRow}.
|
|
869
|
+
*
|
|
870
|
+
* boolean that sets the view to week mode or month mode
|
|
871
|
+
*
|
|
872
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
873
|
+
*
|
|
874
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
875
|
+
*/
|
|
876
|
+
setSingleRow(
|
|
877
|
+
/**
|
|
878
|
+
* New value for property `singleRow`
|
|
879
|
+
*/
|
|
880
|
+
bSingleRow?: boolean
|
|
881
|
+
): this;
|
|
882
|
+
/**
|
|
883
|
+
* Sets a new value for property {@link #getSwipeToNavigate swipeToNavigate}.
|
|
884
|
+
*
|
|
885
|
+
* When enabled, swipe gestures will navigate and not select
|
|
886
|
+
*
|
|
887
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
888
|
+
*
|
|
889
|
+
* Default value is `false`.
|
|
890
|
+
*
|
|
891
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
892
|
+
*/
|
|
893
|
+
setSwipeToNavigate(
|
|
894
|
+
/**
|
|
895
|
+
* New value for property `swipeToNavigate`
|
|
896
|
+
*/
|
|
897
|
+
bSwipeToNavigate?: boolean
|
|
898
|
+
): this;
|
|
899
|
+
/**
|
|
900
|
+
* Sets a new value for property {@link #getVisible visible}.
|
|
901
|
+
*
|
|
902
|
+
* visibility of the control
|
|
903
|
+
*
|
|
904
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
905
|
+
*
|
|
906
|
+
* Default value is `true`.
|
|
907
|
+
*
|
|
908
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
909
|
+
*/
|
|
910
|
+
setVisible(
|
|
911
|
+
/**
|
|
912
|
+
* New value for property `visible`
|
|
913
|
+
*/
|
|
914
|
+
bVisible?: boolean
|
|
915
|
+
): this;
|
|
916
|
+
/**
|
|
917
|
+
* Sets a new value for property {@link #getWeeksPerRow weeksPerRow}.
|
|
918
|
+
*
|
|
919
|
+
* weeks to display in a row
|
|
920
|
+
*
|
|
921
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
922
|
+
*
|
|
923
|
+
* Default value is `1`.
|
|
924
|
+
*
|
|
925
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
926
|
+
*/
|
|
927
|
+
setWeeksPerRow(
|
|
928
|
+
/**
|
|
929
|
+
* New value for property `weeksPerRow`
|
|
930
|
+
*/
|
|
931
|
+
iWeeksPerRow?: int
|
|
932
|
+
): this;
|
|
933
|
+
/**
|
|
934
|
+
* Sets a new value for property {@link #getWidth width}.
|
|
935
|
+
*
|
|
936
|
+
* The width of the calendar
|
|
937
|
+
*
|
|
938
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
939
|
+
*
|
|
940
|
+
* Default value is `'100%'`.
|
|
941
|
+
*
|
|
942
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
943
|
+
*/
|
|
944
|
+
setWidth(
|
|
945
|
+
/**
|
|
946
|
+
* New value for property `width`
|
|
947
|
+
*/
|
|
948
|
+
sWidth?: CSSSize
|
|
949
|
+
): this;
|
|
950
|
+
/**
|
|
951
|
+
* it toggles the selection of the dates within the passed range to selected/unselected
|
|
952
|
+
*/
|
|
953
|
+
toggleDatesRangeSelection(
|
|
954
|
+
/**
|
|
955
|
+
* starting date of the range. It can be Strings or Date objects.
|
|
956
|
+
*/
|
|
957
|
+
oDateStart: any,
|
|
958
|
+
/**
|
|
959
|
+
* ending date of the range. It can be Strings or Date objects.
|
|
960
|
+
*/
|
|
961
|
+
oDateEnd: any,
|
|
962
|
+
/**
|
|
963
|
+
* selected/unselected. Optional, if omitted it inverts each date's current state
|
|
964
|
+
*/
|
|
965
|
+
bSelected: boolean
|
|
966
|
+
): void;
|
|
967
|
+
/**
|
|
968
|
+
* it toggles the passed dates to selected/unselected
|
|
969
|
+
*/
|
|
970
|
+
toggleDatesSelection(
|
|
971
|
+
/**
|
|
972
|
+
* Array of the dates to be toggled. they can be Strings or Date objects.
|
|
973
|
+
*/
|
|
974
|
+
aDates: any,
|
|
975
|
+
/**
|
|
976
|
+
* select/unselect. Optional, if omitted it inverts each date's current state
|
|
977
|
+
*/
|
|
978
|
+
bSelected: boolean
|
|
979
|
+
): void;
|
|
980
|
+
/**
|
|
981
|
+
* Change the type of the given dates
|
|
982
|
+
*/
|
|
983
|
+
toggleDatesType(
|
|
984
|
+
/**
|
|
985
|
+
* An array of dates in string representation
|
|
986
|
+
*/
|
|
987
|
+
aDates: any,
|
|
988
|
+
/**
|
|
989
|
+
* The type of event
|
|
990
|
+
*/
|
|
991
|
+
sType: CalendarEventType | keyof typeof CalendarEventType,
|
|
992
|
+
/**
|
|
993
|
+
* Add/remove the type, if ommited it will toggle
|
|
994
|
+
*/
|
|
995
|
+
bSelected: boolean
|
|
996
|
+
): void;
|
|
997
|
+
/**
|
|
998
|
+
* unselect all the dates
|
|
999
|
+
*/
|
|
1000
|
+
unselectAllDates(): void;
|
|
1001
|
+
}
|
|
1002
|
+
|
|
1003
|
+
export interface $CalendarSettings extends $ControlSettings {
|
|
1004
|
+
/**
|
|
1005
|
+
* visibility of the control
|
|
1006
|
+
*/
|
|
1007
|
+
visible?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1008
|
+
|
|
1009
|
+
/**
|
|
1010
|
+
* hides the area of navigation controls
|
|
1011
|
+
*/
|
|
1012
|
+
hideNavControls?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1013
|
+
|
|
1014
|
+
/**
|
|
1015
|
+
* hides the area of month titles
|
|
1016
|
+
*/
|
|
1017
|
+
hideMonthTitles?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1018
|
+
|
|
1019
|
+
/**
|
|
1020
|
+
* months to display in a row. This sets the width of the whole control in order to contain the desired
|
|
1021
|
+
* number of months per row
|
|
1022
|
+
*/
|
|
1023
|
+
monthsPerRow?: int | PropertyBindingInfo | `{${string}}`;
|
|
1024
|
+
|
|
1025
|
+
/**
|
|
1026
|
+
* the width of a day
|
|
1027
|
+
*/
|
|
1028
|
+
dayWidth?: int | PropertyBindingInfo | `{${string}}`;
|
|
1029
|
+
|
|
1030
|
+
/**
|
|
1031
|
+
* the height of a day
|
|
1032
|
+
*/
|
|
1033
|
+
dayHeight?: int | PropertyBindingInfo | `{${string}}`;
|
|
1034
|
+
|
|
1035
|
+
/**
|
|
1036
|
+
* weeks to display in a row
|
|
1037
|
+
*/
|
|
1038
|
+
weeksPerRow?: int | PropertyBindingInfo | `{${string}}`;
|
|
1039
|
+
|
|
1040
|
+
/**
|
|
1041
|
+
* boolean that sets the view to week mode or month mode
|
|
1042
|
+
*/
|
|
1043
|
+
singleRow?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1044
|
+
|
|
1045
|
+
/**
|
|
1046
|
+
* number of months in a row.
|
|
1047
|
+
*/
|
|
1048
|
+
monthsToDisplay?: int | PropertyBindingInfo | `{${string}}`;
|
|
1049
|
+
|
|
1050
|
+
/**
|
|
1051
|
+
* the center date where the month/week will be built around
|
|
1052
|
+
*/
|
|
1053
|
+
currentDate?: string | PropertyBindingInfo;
|
|
1054
|
+
|
|
1055
|
+
/**
|
|
1056
|
+
* to enable multiselection feature
|
|
1057
|
+
*/
|
|
1058
|
+
enableMultiselection?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1059
|
+
|
|
1060
|
+
/**
|
|
1061
|
+
* to offset the first day of the week (0 = sunday)
|
|
1062
|
+
*/
|
|
1063
|
+
firstDayOffset?: int | PropertyBindingInfo | `{${string}}`;
|
|
1064
|
+
|
|
1065
|
+
/**
|
|
1066
|
+
* Array of weekDays (as integers where 0=Sunday, 1=Monday etc) to be disabled. Interaction will be disabled
|
|
1067
|
+
* for these week days.
|
|
1068
|
+
*/
|
|
1069
|
+
disabledWeekDays?: any | PropertyBindingInfo | `{${string}}`;
|
|
1070
|
+
|
|
1071
|
+
/**
|
|
1072
|
+
* Array of specific dates (strings or Date objects) that will be disabled/non interactive
|
|
1073
|
+
*/
|
|
1074
|
+
disabledDates?: any | PropertyBindingInfo | `{${string}}`;
|
|
1075
|
+
|
|
1076
|
+
/**
|
|
1077
|
+
* When enabled, swipe gestures will navigate and not select
|
|
1078
|
+
*/
|
|
1079
|
+
swipeToNavigate?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1080
|
+
|
|
1081
|
+
/**
|
|
1082
|
+
* Indicates the design of the calendar (mainly colors)
|
|
1083
|
+
*/
|
|
1084
|
+
design?:
|
|
1085
|
+
| (CalendarDesign | keyof typeof CalendarDesign)
|
|
1086
|
+
| PropertyBindingInfo
|
|
1087
|
+
| `{${string}}`;
|
|
1088
|
+
|
|
1089
|
+
/**
|
|
1090
|
+
* Indicates the design of the calendar (mainly colors)
|
|
1091
|
+
*/
|
|
1092
|
+
selectionMode?:
|
|
1093
|
+
| (CalendarSelectionMode | keyof typeof CalendarSelectionMode)
|
|
1094
|
+
| PropertyBindingInfo
|
|
1095
|
+
| `{${string}}`;
|
|
1096
|
+
|
|
1097
|
+
/**
|
|
1098
|
+
* The width of the calendar
|
|
1099
|
+
*/
|
|
1100
|
+
width?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
1101
|
+
|
|
1102
|
+
/**
|
|
1103
|
+
* Array of day names, default value is sap.m.getLocaleData().getDays("abbreviated") Check sap.ui.core.LocaleData
|
|
1104
|
+
* documentation for more info.
|
|
1105
|
+
*/
|
|
1106
|
+
days?: any | PropertyBindingInfo | `{${string}}`;
|
|
1107
|
+
|
|
1108
|
+
/**
|
|
1109
|
+
* Array of month names, default value is sap.m.getLocaleData().getMonths("abbreviated") Check sap.ui.core.LocaleData
|
|
1110
|
+
* documentation for more info.
|
|
1111
|
+
*/
|
|
1112
|
+
months?: any | PropertyBindingInfo | `{${string}}`;
|
|
1113
|
+
|
|
1114
|
+
/**
|
|
1115
|
+
* event fired when a date is tapped
|
|
1116
|
+
*/
|
|
1117
|
+
tapOnDate?: (oEvent: Event) => void;
|
|
1118
|
+
|
|
1119
|
+
/**
|
|
1120
|
+
* event fired when tap to next or previous button and currentDate is updated
|
|
1121
|
+
*/
|
|
1122
|
+
changeCurrentDate?: (oEvent: Event) => void;
|
|
1123
|
+
|
|
1124
|
+
/**
|
|
1125
|
+
* when the range of selected dates changes
|
|
1126
|
+
*/
|
|
1127
|
+
changeRange?: (oEvent: Event) => void;
|
|
1128
|
+
}
|
|
1129
|
+
}
|
|
1130
|
+
|
|
1131
|
+
declare module "sap/me/CalendarLegend" {
|
|
1132
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
1133
|
+
|
|
1134
|
+
import { CalendarDesign } from "sap/me/library";
|
|
1135
|
+
|
|
1136
|
+
import { CSSSize } from "sap/ui/core/library";
|
|
1137
|
+
|
|
1138
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
1139
|
+
|
|
1140
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
1141
|
+
|
|
1142
|
+
/**
|
|
1143
|
+
* @deprecated (since 1.34.0) - This control was experimental since 1.12. Please use the sap.ui.unified.CalendarLegend
|
|
1144
|
+
* instead!
|
|
1145
|
+
*
|
|
1146
|
+
* Legend for the calendar control
|
|
1147
|
+
*/
|
|
1148
|
+
export default class CalendarLegend extends Control {
|
|
1149
|
+
/**
|
|
1150
|
+
* Constructor for a new CalendarLegend.
|
|
1151
|
+
*
|
|
1152
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1153
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1154
|
+
* of the syntax of the settings object.
|
|
1155
|
+
*/
|
|
1156
|
+
constructor(
|
|
1157
|
+
/**
|
|
1158
|
+
* initial settings for the new control
|
|
1159
|
+
*/
|
|
1160
|
+
mSettings?: $CalendarLegendSettings
|
|
1161
|
+
);
|
|
1162
|
+
/**
|
|
1163
|
+
* Constructor for a new CalendarLegend.
|
|
1164
|
+
*
|
|
1165
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1166
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1167
|
+
* of the syntax of the settings object.
|
|
1168
|
+
*/
|
|
1169
|
+
constructor(
|
|
1170
|
+
/**
|
|
1171
|
+
* id for the new control, generated automatically if no id is given
|
|
1172
|
+
*/
|
|
1173
|
+
sId?: string,
|
|
1174
|
+
/**
|
|
1175
|
+
* initial settings for the new control
|
|
1176
|
+
*/
|
|
1177
|
+
mSettings?: $CalendarLegendSettings
|
|
1178
|
+
);
|
|
1179
|
+
|
|
1180
|
+
/**
|
|
1181
|
+
* Creates a new subclass of class sap.me.CalendarLegend with name `sClassName` and enriches it with the
|
|
1182
|
+
* information contained in `oClassInfo`.
|
|
1183
|
+
*
|
|
1184
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
1185
|
+
*
|
|
1186
|
+
* @returns Created class / constructor function
|
|
1187
|
+
*/
|
|
1188
|
+
static extend<T extends Record<string, unknown>>(
|
|
1189
|
+
/**
|
|
1190
|
+
* Name of the class being created
|
|
1191
|
+
*/
|
|
1192
|
+
sClassName: string,
|
|
1193
|
+
/**
|
|
1194
|
+
* Object literal with information about the class
|
|
1195
|
+
*/
|
|
1196
|
+
oClassInfo?: sap.ClassInfo<T, CalendarLegend>,
|
|
1197
|
+
/**
|
|
1198
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1199
|
+
* used by this class
|
|
1200
|
+
*/
|
|
1201
|
+
FNMetaImpl?: Function
|
|
1202
|
+
): Function;
|
|
1203
|
+
/**
|
|
1204
|
+
* Returns a metadata object for class sap.me.CalendarLegend.
|
|
1205
|
+
*
|
|
1206
|
+
* @returns Metadata object describing this class
|
|
1207
|
+
*/
|
|
1208
|
+
static getMetadata(): ElementMetadata;
|
|
1209
|
+
/**
|
|
1210
|
+
* Gets current value of property {@link #getDesign design}.
|
|
1211
|
+
*
|
|
1212
|
+
* design name for the legend
|
|
1213
|
+
*
|
|
1214
|
+
* Default value is `Approval`.
|
|
1215
|
+
*
|
|
1216
|
+
* @returns Value of property `design`
|
|
1217
|
+
*/
|
|
1218
|
+
getDesign(): CalendarDesign | keyof typeof CalendarDesign;
|
|
1219
|
+
/**
|
|
1220
|
+
* Gets current value of property {@link #getExpandable expandable}.
|
|
1221
|
+
*
|
|
1222
|
+
* Indicates if the legend can be collapsed and expanded
|
|
1223
|
+
*
|
|
1224
|
+
* Default value is `true`.
|
|
1225
|
+
*
|
|
1226
|
+
* @returns Value of property `expandable`
|
|
1227
|
+
*/
|
|
1228
|
+
getExpandable(): boolean;
|
|
1229
|
+
/**
|
|
1230
|
+
* Gets current value of property {@link #getExpanded expanded}.
|
|
1231
|
+
*
|
|
1232
|
+
* Indicates if the legend is expanded or not
|
|
1233
|
+
*
|
|
1234
|
+
* Default value is `true`.
|
|
1235
|
+
*
|
|
1236
|
+
* @returns Value of property `expanded`
|
|
1237
|
+
*/
|
|
1238
|
+
getExpanded(): boolean;
|
|
1239
|
+
/**
|
|
1240
|
+
* Gets current value of property {@link #getLegendForNormal legendForNormal}.
|
|
1241
|
+
*
|
|
1242
|
+
* legend for normal
|
|
1243
|
+
*
|
|
1244
|
+
* @returns Value of property `legendForNormal`
|
|
1245
|
+
*/
|
|
1246
|
+
getLegendForNormal(): string;
|
|
1247
|
+
/**
|
|
1248
|
+
* Gets current value of property {@link #getLegendForSelected legendForSelected}.
|
|
1249
|
+
*
|
|
1250
|
+
* legend for selected
|
|
1251
|
+
*
|
|
1252
|
+
* @returns Value of property `legendForSelected`
|
|
1253
|
+
*/
|
|
1254
|
+
getLegendForSelected(): string;
|
|
1255
|
+
/**
|
|
1256
|
+
* Gets current value of property {@link #getLegendForSelected00 legendForSelected00}.
|
|
1257
|
+
*
|
|
1258
|
+
* legend for selected 00
|
|
1259
|
+
*
|
|
1260
|
+
* @returns Value of property `legendForSelected00`
|
|
1261
|
+
*/
|
|
1262
|
+
getLegendForSelected00(): string;
|
|
1263
|
+
/**
|
|
1264
|
+
* Gets current value of property {@link #getLegendForToday legendForToday}.
|
|
1265
|
+
*
|
|
1266
|
+
* legend for today
|
|
1267
|
+
*
|
|
1268
|
+
* @returns Value of property `legendForToday`
|
|
1269
|
+
*/
|
|
1270
|
+
getLegendForToday(): string;
|
|
1271
|
+
/**
|
|
1272
|
+
* Gets current value of property {@link #getLegendForType00 legendForType00}.
|
|
1273
|
+
*
|
|
1274
|
+
* legend for type 00
|
|
1275
|
+
*
|
|
1276
|
+
* @returns Value of property `legendForType00`
|
|
1277
|
+
*/
|
|
1278
|
+
getLegendForType00(): string;
|
|
1279
|
+
/**
|
|
1280
|
+
* Gets current value of property {@link #getLegendForType01 legendForType01}.
|
|
1281
|
+
*
|
|
1282
|
+
* legend for type 01
|
|
1283
|
+
*
|
|
1284
|
+
* @returns Value of property `legendForType01`
|
|
1285
|
+
*/
|
|
1286
|
+
getLegendForType01(): string;
|
|
1287
|
+
/**
|
|
1288
|
+
* Gets current value of property {@link #getLegendForType04 legendForType04}.
|
|
1289
|
+
*
|
|
1290
|
+
* legend for type 04
|
|
1291
|
+
*
|
|
1292
|
+
* @returns Value of property `legendForType04`
|
|
1293
|
+
*/
|
|
1294
|
+
getLegendForType04(): string;
|
|
1295
|
+
/**
|
|
1296
|
+
* Gets current value of property {@link #getLegendForType06 legendForType06}.
|
|
1297
|
+
*
|
|
1298
|
+
* legend for type 06
|
|
1299
|
+
*
|
|
1300
|
+
* @returns Value of property `legendForType06`
|
|
1301
|
+
*/
|
|
1302
|
+
getLegendForType06(): string;
|
|
1303
|
+
/**
|
|
1304
|
+
* Gets current value of property {@link #getLegendForType07 legendForType07}.
|
|
1305
|
+
*
|
|
1306
|
+
* legend for type 07
|
|
1307
|
+
*
|
|
1308
|
+
* @returns Value of property `legendForType07`
|
|
1309
|
+
*/
|
|
1310
|
+
getLegendForType07(): string;
|
|
1311
|
+
/**
|
|
1312
|
+
* Gets current value of property {@link #getLegendWidth legendWidth}.
|
|
1313
|
+
*
|
|
1314
|
+
* Indicates the legend items width
|
|
1315
|
+
*
|
|
1316
|
+
* Default value is `'12.5rem'`.
|
|
1317
|
+
*
|
|
1318
|
+
* @returns Value of property `legendWidth`
|
|
1319
|
+
*/
|
|
1320
|
+
getLegendWidth(): CSSSize;
|
|
1321
|
+
/**
|
|
1322
|
+
* Gets current value of property {@link #getVisible visible}.
|
|
1323
|
+
*
|
|
1324
|
+
* Indicates if the legend is visible
|
|
1325
|
+
*
|
|
1326
|
+
* Default value is `true`.
|
|
1327
|
+
*
|
|
1328
|
+
* @returns Value of property `visible`
|
|
1329
|
+
*/
|
|
1330
|
+
getVisible(): boolean;
|
|
1331
|
+
/**
|
|
1332
|
+
* Gets current value of property {@link #getWidth width}.
|
|
1333
|
+
*
|
|
1334
|
+
* Indicates the whole component width
|
|
1335
|
+
*
|
|
1336
|
+
* Default value is `'auto'`.
|
|
1337
|
+
*
|
|
1338
|
+
* @returns Value of property `width`
|
|
1339
|
+
*/
|
|
1340
|
+
getWidth(): CSSSize;
|
|
1341
|
+
/**
|
|
1342
|
+
* Sets a new value for property {@link #getDesign design}.
|
|
1343
|
+
*
|
|
1344
|
+
* design name for the legend
|
|
1345
|
+
*
|
|
1346
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1347
|
+
*
|
|
1348
|
+
* Default value is `Approval`.
|
|
1349
|
+
*
|
|
1350
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1351
|
+
*/
|
|
1352
|
+
setDesign(
|
|
1353
|
+
/**
|
|
1354
|
+
* New value for property `design`
|
|
1355
|
+
*/
|
|
1356
|
+
sDesign?: CalendarDesign | keyof typeof CalendarDesign
|
|
1357
|
+
): this;
|
|
1358
|
+
/**
|
|
1359
|
+
* Sets a new value for property {@link #getExpandable expandable}.
|
|
1360
|
+
*
|
|
1361
|
+
* Indicates if the legend can be collapsed and expanded
|
|
1362
|
+
*
|
|
1363
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1364
|
+
*
|
|
1365
|
+
* Default value is `true`.
|
|
1366
|
+
*
|
|
1367
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1368
|
+
*/
|
|
1369
|
+
setExpandable(
|
|
1370
|
+
/**
|
|
1371
|
+
* New value for property `expandable`
|
|
1372
|
+
*/
|
|
1373
|
+
bExpandable?: boolean
|
|
1374
|
+
): this;
|
|
1375
|
+
/**
|
|
1376
|
+
* Sets a new value for property {@link #getExpanded expanded}.
|
|
1377
|
+
*
|
|
1378
|
+
* Indicates if the legend is expanded or not
|
|
1379
|
+
*
|
|
1380
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1381
|
+
*
|
|
1382
|
+
* Default value is `true`.
|
|
1383
|
+
*
|
|
1384
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1385
|
+
*/
|
|
1386
|
+
setExpanded(
|
|
1387
|
+
/**
|
|
1388
|
+
* New value for property `expanded`
|
|
1389
|
+
*/
|
|
1390
|
+
bExpanded?: boolean
|
|
1391
|
+
): this;
|
|
1392
|
+
/**
|
|
1393
|
+
* Sets a new value for property {@link #getLegendForNormal legendForNormal}.
|
|
1394
|
+
*
|
|
1395
|
+
* legend for normal
|
|
1396
|
+
*
|
|
1397
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1398
|
+
*
|
|
1399
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1400
|
+
*/
|
|
1401
|
+
setLegendForNormal(
|
|
1402
|
+
/**
|
|
1403
|
+
* New value for property `legendForNormal`
|
|
1404
|
+
*/
|
|
1405
|
+
sLegendForNormal?: string
|
|
1406
|
+
): this;
|
|
1407
|
+
/**
|
|
1408
|
+
* Sets a new value for property {@link #getLegendForSelected legendForSelected}.
|
|
1409
|
+
*
|
|
1410
|
+
* legend for selected
|
|
1411
|
+
*
|
|
1412
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1413
|
+
*
|
|
1414
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1415
|
+
*/
|
|
1416
|
+
setLegendForSelected(
|
|
1417
|
+
/**
|
|
1418
|
+
* New value for property `legendForSelected`
|
|
1419
|
+
*/
|
|
1420
|
+
sLegendForSelected?: string
|
|
1421
|
+
): this;
|
|
1422
|
+
/**
|
|
1423
|
+
* Sets a new value for property {@link #getLegendForSelected00 legendForSelected00}.
|
|
1424
|
+
*
|
|
1425
|
+
* legend for selected 00
|
|
1426
|
+
*
|
|
1427
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1428
|
+
*
|
|
1429
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1430
|
+
*/
|
|
1431
|
+
setLegendForSelected00(
|
|
1432
|
+
/**
|
|
1433
|
+
* New value for property `legendForSelected00`
|
|
1434
|
+
*/
|
|
1435
|
+
sLegendForSelected00?: string
|
|
1436
|
+
): this;
|
|
1437
|
+
/**
|
|
1438
|
+
* Sets a new value for property {@link #getLegendForToday legendForToday}.
|
|
1439
|
+
*
|
|
1440
|
+
* legend for today
|
|
1441
|
+
*
|
|
1442
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1443
|
+
*
|
|
1444
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1445
|
+
*/
|
|
1446
|
+
setLegendForToday(
|
|
1447
|
+
/**
|
|
1448
|
+
* New value for property `legendForToday`
|
|
1449
|
+
*/
|
|
1450
|
+
sLegendForToday?: string
|
|
1451
|
+
): this;
|
|
1452
|
+
/**
|
|
1453
|
+
* Sets a new value for property {@link #getLegendForType00 legendForType00}.
|
|
1454
|
+
*
|
|
1455
|
+
* legend for type 00
|
|
1456
|
+
*
|
|
1457
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1458
|
+
*
|
|
1459
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1460
|
+
*/
|
|
1461
|
+
setLegendForType00(
|
|
1462
|
+
/**
|
|
1463
|
+
* New value for property `legendForType00`
|
|
1464
|
+
*/
|
|
1465
|
+
sLegendForType00?: string
|
|
1466
|
+
): this;
|
|
1467
|
+
/**
|
|
1468
|
+
* Sets a new value for property {@link #getLegendForType01 legendForType01}.
|
|
1469
|
+
*
|
|
1470
|
+
* legend for type 01
|
|
1471
|
+
*
|
|
1472
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1473
|
+
*
|
|
1474
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1475
|
+
*/
|
|
1476
|
+
setLegendForType01(
|
|
1477
|
+
/**
|
|
1478
|
+
* New value for property `legendForType01`
|
|
1479
|
+
*/
|
|
1480
|
+
sLegendForType01?: string
|
|
1481
|
+
): this;
|
|
1482
|
+
/**
|
|
1483
|
+
* Sets a new value for property {@link #getLegendForType04 legendForType04}.
|
|
1484
|
+
*
|
|
1485
|
+
* legend for type 04
|
|
1486
|
+
*
|
|
1487
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1488
|
+
*
|
|
1489
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1490
|
+
*/
|
|
1491
|
+
setLegendForType04(
|
|
1492
|
+
/**
|
|
1493
|
+
* New value for property `legendForType04`
|
|
1494
|
+
*/
|
|
1495
|
+
sLegendForType04?: string
|
|
1496
|
+
): this;
|
|
1497
|
+
/**
|
|
1498
|
+
* Sets a new value for property {@link #getLegendForType06 legendForType06}.
|
|
1499
|
+
*
|
|
1500
|
+
* legend for type 06
|
|
1501
|
+
*
|
|
1502
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1503
|
+
*
|
|
1504
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1505
|
+
*/
|
|
1506
|
+
setLegendForType06(
|
|
1507
|
+
/**
|
|
1508
|
+
* New value for property `legendForType06`
|
|
1509
|
+
*/
|
|
1510
|
+
sLegendForType06?: string
|
|
1511
|
+
): this;
|
|
1512
|
+
/**
|
|
1513
|
+
* Sets a new value for property {@link #getLegendForType07 legendForType07}.
|
|
1514
|
+
*
|
|
1515
|
+
* legend for type 07
|
|
1516
|
+
*
|
|
1517
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1518
|
+
*
|
|
1519
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1520
|
+
*/
|
|
1521
|
+
setLegendForType07(
|
|
1522
|
+
/**
|
|
1523
|
+
* New value for property `legendForType07`
|
|
1524
|
+
*/
|
|
1525
|
+
sLegendForType07?: string
|
|
1526
|
+
): this;
|
|
1527
|
+
/**
|
|
1528
|
+
* Sets a new value for property {@link #getLegendWidth legendWidth}.
|
|
1529
|
+
*
|
|
1530
|
+
* Indicates the legend items width
|
|
1531
|
+
*
|
|
1532
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1533
|
+
*
|
|
1534
|
+
* Default value is `'12.5rem'`.
|
|
1535
|
+
*
|
|
1536
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1537
|
+
*/
|
|
1538
|
+
setLegendWidth(
|
|
1539
|
+
/**
|
|
1540
|
+
* New value for property `legendWidth`
|
|
1541
|
+
*/
|
|
1542
|
+
sLegendWidth?: CSSSize
|
|
1543
|
+
): this;
|
|
1544
|
+
/**
|
|
1545
|
+
* Sets a new value for property {@link #getVisible visible}.
|
|
1546
|
+
*
|
|
1547
|
+
* Indicates if the legend is visible
|
|
1548
|
+
*
|
|
1549
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1550
|
+
*
|
|
1551
|
+
* Default value is `true`.
|
|
1552
|
+
*
|
|
1553
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1554
|
+
*/
|
|
1555
|
+
setVisible(
|
|
1556
|
+
/**
|
|
1557
|
+
* New value for property `visible`
|
|
1558
|
+
*/
|
|
1559
|
+
bVisible?: boolean
|
|
1560
|
+
): this;
|
|
1561
|
+
/**
|
|
1562
|
+
* Sets a new value for property {@link #getWidth width}.
|
|
1563
|
+
*
|
|
1564
|
+
* Indicates the whole component width
|
|
1565
|
+
*
|
|
1566
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1567
|
+
*
|
|
1568
|
+
* Default value is `'auto'`.
|
|
1569
|
+
*
|
|
1570
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1571
|
+
*/
|
|
1572
|
+
setWidth(
|
|
1573
|
+
/**
|
|
1574
|
+
* New value for property `width`
|
|
1575
|
+
*/
|
|
1576
|
+
sWidth?: CSSSize
|
|
1577
|
+
): this;
|
|
1578
|
+
}
|
|
1579
|
+
|
|
1580
|
+
export interface $CalendarLegendSettings extends $ControlSettings {
|
|
1581
|
+
/**
|
|
1582
|
+
* legend for type 00
|
|
1583
|
+
*/
|
|
1584
|
+
legendForType00?: string | PropertyBindingInfo;
|
|
1585
|
+
|
|
1586
|
+
/**
|
|
1587
|
+
* legend for type 01
|
|
1588
|
+
*/
|
|
1589
|
+
legendForType01?: string | PropertyBindingInfo;
|
|
1590
|
+
|
|
1591
|
+
/**
|
|
1592
|
+
* legend for type 04
|
|
1593
|
+
*/
|
|
1594
|
+
legendForType04?: string | PropertyBindingInfo;
|
|
1595
|
+
|
|
1596
|
+
/**
|
|
1597
|
+
* legend for type 06
|
|
1598
|
+
*/
|
|
1599
|
+
legendForType06?: string | PropertyBindingInfo;
|
|
1600
|
+
|
|
1601
|
+
/**
|
|
1602
|
+
* legend for type 07
|
|
1603
|
+
*/
|
|
1604
|
+
legendForType07?: string | PropertyBindingInfo;
|
|
1605
|
+
|
|
1606
|
+
/**
|
|
1607
|
+
* legend for today
|
|
1608
|
+
*/
|
|
1609
|
+
legendForToday?: string | PropertyBindingInfo;
|
|
1610
|
+
|
|
1611
|
+
/**
|
|
1612
|
+
* legend for selected
|
|
1613
|
+
*/
|
|
1614
|
+
legendForSelected?: string | PropertyBindingInfo;
|
|
1615
|
+
|
|
1616
|
+
/**
|
|
1617
|
+
* legend for selected 00
|
|
1618
|
+
*/
|
|
1619
|
+
legendForSelected00?: string | PropertyBindingInfo;
|
|
1620
|
+
|
|
1621
|
+
/**
|
|
1622
|
+
* legend for normal
|
|
1623
|
+
*/
|
|
1624
|
+
legendForNormal?: string | PropertyBindingInfo;
|
|
1625
|
+
|
|
1626
|
+
/**
|
|
1627
|
+
* Indicates if the legend can be collapsed and expanded
|
|
1628
|
+
*/
|
|
1629
|
+
expandable?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1630
|
+
|
|
1631
|
+
/**
|
|
1632
|
+
* Indicates if the legend is expanded or not
|
|
1633
|
+
*/
|
|
1634
|
+
expanded?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1635
|
+
|
|
1636
|
+
/**
|
|
1637
|
+
* Indicates the whole component width
|
|
1638
|
+
*/
|
|
1639
|
+
width?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
1640
|
+
|
|
1641
|
+
/**
|
|
1642
|
+
* Indicates the legend items width
|
|
1643
|
+
*/
|
|
1644
|
+
legendWidth?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
1645
|
+
|
|
1646
|
+
/**
|
|
1647
|
+
* Indicates if the legend is visible
|
|
1648
|
+
*/
|
|
1649
|
+
visible?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1650
|
+
|
|
1651
|
+
/**
|
|
1652
|
+
* design name for the legend
|
|
1653
|
+
*/
|
|
1654
|
+
design?:
|
|
1655
|
+
| (CalendarDesign | keyof typeof CalendarDesign)
|
|
1656
|
+
| PropertyBindingInfo
|
|
1657
|
+
| `{${string}}`;
|
|
1658
|
+
}
|
|
1659
|
+
}
|
|
1660
|
+
|
|
1661
|
+
declare module "sap/me/OverlapCalendar" {
|
|
1662
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
1663
|
+
|
|
1664
|
+
import OverlapCalendarEvent from "sap/me/OverlapCalendarEvent";
|
|
1665
|
+
|
|
1666
|
+
import Event from "sap/ui/base/Event";
|
|
1667
|
+
|
|
1668
|
+
import Calendar from "sap/me/Calendar";
|
|
1669
|
+
|
|
1670
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
1671
|
+
|
|
1672
|
+
import { CSSSize } from "sap/ui/core/library";
|
|
1673
|
+
|
|
1674
|
+
import {
|
|
1675
|
+
PropertyBindingInfo,
|
|
1676
|
+
AggregationBindingInfo,
|
|
1677
|
+
} from "sap/ui/base/ManagedObject";
|
|
1678
|
+
|
|
1679
|
+
/**
|
|
1680
|
+
* @deprecated (since 1.34.0) - This control was experimental since 1.12. Please use the sap.m.PlanningCalendar
|
|
1681
|
+
* instead!
|
|
1682
|
+
*
|
|
1683
|
+
* A calendar that allows to display events in a grid and show the overlapped events
|
|
1684
|
+
*/
|
|
1685
|
+
export default class OverlapCalendar extends Control {
|
|
1686
|
+
/**
|
|
1687
|
+
* Constructor for a new OverlapCalendar.
|
|
1688
|
+
*
|
|
1689
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1690
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1691
|
+
* of the syntax of the settings object.
|
|
1692
|
+
*/
|
|
1693
|
+
constructor(
|
|
1694
|
+
/**
|
|
1695
|
+
* initial settings for the new control
|
|
1696
|
+
*/
|
|
1697
|
+
mSettings?: $OverlapCalendarSettings
|
|
1698
|
+
);
|
|
1699
|
+
/**
|
|
1700
|
+
* Constructor for a new OverlapCalendar.
|
|
1701
|
+
*
|
|
1702
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1703
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1704
|
+
* of the syntax of the settings object.
|
|
1705
|
+
*/
|
|
1706
|
+
constructor(
|
|
1707
|
+
/**
|
|
1708
|
+
* id for the new control, generated automatically if no id is given
|
|
1709
|
+
*/
|
|
1710
|
+
sId?: string,
|
|
1711
|
+
/**
|
|
1712
|
+
* initial settings for the new control
|
|
1713
|
+
*/
|
|
1714
|
+
mSettings?: $OverlapCalendarSettings
|
|
1715
|
+
);
|
|
1716
|
+
|
|
1717
|
+
/**
|
|
1718
|
+
* Creates a new subclass of class sap.me.OverlapCalendar with name `sClassName` and enriches it with the
|
|
1719
|
+
* information contained in `oClassInfo`.
|
|
1720
|
+
*
|
|
1721
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
1722
|
+
*
|
|
1723
|
+
* @returns Created class / constructor function
|
|
1724
|
+
*/
|
|
1725
|
+
static extend<T extends Record<string, unknown>>(
|
|
1726
|
+
/**
|
|
1727
|
+
* Name of the class being created
|
|
1728
|
+
*/
|
|
1729
|
+
sClassName: string,
|
|
1730
|
+
/**
|
|
1731
|
+
* Object literal with information about the class
|
|
1732
|
+
*/
|
|
1733
|
+
oClassInfo?: sap.ClassInfo<T, OverlapCalendar>,
|
|
1734
|
+
/**
|
|
1735
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1736
|
+
* used by this class
|
|
1737
|
+
*/
|
|
1738
|
+
FNMetaImpl?: Function
|
|
1739
|
+
): Function;
|
|
1740
|
+
/**
|
|
1741
|
+
* Returns a metadata object for class sap.me.OverlapCalendar.
|
|
1742
|
+
*
|
|
1743
|
+
* @returns Metadata object describing this class
|
|
1744
|
+
*/
|
|
1745
|
+
static getMetadata(): ElementMetadata;
|
|
1746
|
+
/**
|
|
1747
|
+
* Adds some calendarEvent to the aggregation {@link #getCalendarEvents calendarEvents}.
|
|
1748
|
+
*
|
|
1749
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1750
|
+
*/
|
|
1751
|
+
addCalendarEvent(
|
|
1752
|
+
/**
|
|
1753
|
+
* The calendarEvent to add; if empty, nothing is inserted
|
|
1754
|
+
*/
|
|
1755
|
+
oCalendarEvent: OverlapCalendarEvent
|
|
1756
|
+
): this;
|
|
1757
|
+
/**
|
|
1758
|
+
* Attaches event handler `fnFunction` to the {@link #event:changeDate changeDate} event of this `sap.me.OverlapCalendar`.
|
|
1759
|
+
*
|
|
1760
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
1761
|
+
* otherwise it will be bound to this `sap.me.OverlapCalendar` itself.
|
|
1762
|
+
*
|
|
1763
|
+
* Triggered when the displayed dates change
|
|
1764
|
+
*
|
|
1765
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1766
|
+
*/
|
|
1767
|
+
attachChangeDate(
|
|
1768
|
+
/**
|
|
1769
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
1770
|
+
* object when firing the event
|
|
1771
|
+
*/
|
|
1772
|
+
oData: object,
|
|
1773
|
+
/**
|
|
1774
|
+
* The function to be called when the event occurs
|
|
1775
|
+
*/
|
|
1776
|
+
fnFunction: (p1: Event) => void,
|
|
1777
|
+
/**
|
|
1778
|
+
* Context object to call the event handler with. Defaults to this `sap.me.OverlapCalendar` itself
|
|
1779
|
+
*/
|
|
1780
|
+
oListener?: object
|
|
1781
|
+
): this;
|
|
1782
|
+
/**
|
|
1783
|
+
* Attaches event handler `fnFunction` to the {@link #event:changeDate changeDate} event of this `sap.me.OverlapCalendar`.
|
|
1784
|
+
*
|
|
1785
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
1786
|
+
* otherwise it will be bound to this `sap.me.OverlapCalendar` itself.
|
|
1787
|
+
*
|
|
1788
|
+
* Triggered when the displayed dates change
|
|
1789
|
+
*
|
|
1790
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1791
|
+
*/
|
|
1792
|
+
attachChangeDate(
|
|
1793
|
+
/**
|
|
1794
|
+
* The function to be called when the event occurs
|
|
1795
|
+
*/
|
|
1796
|
+
fnFunction: (p1: Event) => void,
|
|
1797
|
+
/**
|
|
1798
|
+
* Context object to call the event handler with. Defaults to this `sap.me.OverlapCalendar` itself
|
|
1799
|
+
*/
|
|
1800
|
+
oListener?: object
|
|
1801
|
+
): this;
|
|
1802
|
+
/**
|
|
1803
|
+
* Attaches event handler `fnFunction` to the {@link #event:endOfData endOfData} event of this `sap.me.OverlapCalendar`.
|
|
1804
|
+
*
|
|
1805
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
1806
|
+
* otherwise it will be bound to this `sap.me.OverlapCalendar` itself.
|
|
1807
|
+
*
|
|
1808
|
+
* Indicates that we have reach the last week with data
|
|
1809
|
+
*
|
|
1810
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1811
|
+
*/
|
|
1812
|
+
attachEndOfData(
|
|
1813
|
+
/**
|
|
1814
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
1815
|
+
* object when firing the event
|
|
1816
|
+
*/
|
|
1817
|
+
oData: object,
|
|
1818
|
+
/**
|
|
1819
|
+
* The function to be called when the event occurs
|
|
1820
|
+
*/
|
|
1821
|
+
fnFunction: (p1: Event) => void,
|
|
1822
|
+
/**
|
|
1823
|
+
* Context object to call the event handler with. Defaults to this `sap.me.OverlapCalendar` itself
|
|
1824
|
+
*/
|
|
1825
|
+
oListener?: object
|
|
1826
|
+
): this;
|
|
1827
|
+
/**
|
|
1828
|
+
* Attaches event handler `fnFunction` to the {@link #event:endOfData endOfData} event of this `sap.me.OverlapCalendar`.
|
|
1829
|
+
*
|
|
1830
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
1831
|
+
* otherwise it will be bound to this `sap.me.OverlapCalendar` itself.
|
|
1832
|
+
*
|
|
1833
|
+
* Indicates that we have reach the last week with data
|
|
1834
|
+
*
|
|
1835
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1836
|
+
*/
|
|
1837
|
+
attachEndOfData(
|
|
1838
|
+
/**
|
|
1839
|
+
* The function to be called when the event occurs
|
|
1840
|
+
*/
|
|
1841
|
+
fnFunction: (p1: Event) => void,
|
|
1842
|
+
/**
|
|
1843
|
+
* Context object to call the event handler with. Defaults to this `sap.me.OverlapCalendar` itself
|
|
1844
|
+
*/
|
|
1845
|
+
oListener?: object
|
|
1846
|
+
): this;
|
|
1847
|
+
/**
|
|
1848
|
+
* Destroys all the calendarEvents in the aggregation {@link #getCalendarEvents calendarEvents}.
|
|
1849
|
+
*
|
|
1850
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1851
|
+
*/
|
|
1852
|
+
destroyCalendarEvents(): this;
|
|
1853
|
+
/**
|
|
1854
|
+
* Detaches event handler `fnFunction` from the {@link #event:changeDate changeDate} event of this `sap.me.OverlapCalendar`.
|
|
1855
|
+
*
|
|
1856
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
1857
|
+
*
|
|
1858
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1859
|
+
*/
|
|
1860
|
+
detachChangeDate(
|
|
1861
|
+
/**
|
|
1862
|
+
* The function to be called, when the event occurs
|
|
1863
|
+
*/
|
|
1864
|
+
fnFunction: (p1: Event) => void,
|
|
1865
|
+
/**
|
|
1866
|
+
* Context object on which the given function had to be called
|
|
1867
|
+
*/
|
|
1868
|
+
oListener?: object
|
|
1869
|
+
): this;
|
|
1870
|
+
/**
|
|
1871
|
+
* Detaches event handler `fnFunction` from the {@link #event:endOfData endOfData} event of this `sap.me.OverlapCalendar`.
|
|
1872
|
+
*
|
|
1873
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
1874
|
+
*
|
|
1875
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1876
|
+
*/
|
|
1877
|
+
detachEndOfData(
|
|
1878
|
+
/**
|
|
1879
|
+
* The function to be called, when the event occurs
|
|
1880
|
+
*/
|
|
1881
|
+
fnFunction: (p1: Event) => void,
|
|
1882
|
+
/**
|
|
1883
|
+
* Context object on which the given function had to be called
|
|
1884
|
+
*/
|
|
1885
|
+
oListener?: object
|
|
1886
|
+
): this;
|
|
1887
|
+
/**
|
|
1888
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
1889
|
+
*
|
|
1890
|
+
* Fires event {@link #event:changeDate changeDate} to attached listeners.
|
|
1891
|
+
*
|
|
1892
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1893
|
+
*/
|
|
1894
|
+
fireChangeDate(
|
|
1895
|
+
/**
|
|
1896
|
+
* Parameters to pass along with the event
|
|
1897
|
+
*/
|
|
1898
|
+
mParameters?: {
|
|
1899
|
+
/**
|
|
1900
|
+
* The first date displayed in the calendar
|
|
1901
|
+
*/
|
|
1902
|
+
firstDate?: object;
|
|
1903
|
+
/**
|
|
1904
|
+
* The last date that will be displayed
|
|
1905
|
+
*/
|
|
1906
|
+
lastDate?: object;
|
|
1907
|
+
}
|
|
1908
|
+
): this;
|
|
1909
|
+
/**
|
|
1910
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
1911
|
+
*
|
|
1912
|
+
* Fires event {@link #event:endOfData endOfData} to attached listeners.
|
|
1913
|
+
*
|
|
1914
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1915
|
+
*/
|
|
1916
|
+
fireEndOfData(
|
|
1917
|
+
/**
|
|
1918
|
+
* Parameters to pass along with the event
|
|
1919
|
+
*/
|
|
1920
|
+
mParameters?: {
|
|
1921
|
+
/**
|
|
1922
|
+
* Indicates if the data missing are before the start date or at the end
|
|
1923
|
+
*/
|
|
1924
|
+
before?: boolean;
|
|
1925
|
+
}
|
|
1926
|
+
): this;
|
|
1927
|
+
/**
|
|
1928
|
+
*
|
|
1929
|
+
* @returns The calendar object
|
|
1930
|
+
*/
|
|
1931
|
+
getCalendar(): Calendar;
|
|
1932
|
+
/**
|
|
1933
|
+
* Gets content of aggregation {@link #getCalendarEvents calendarEvents}.
|
|
1934
|
+
*
|
|
1935
|
+
* The list of events to display in the calendar grid
|
|
1936
|
+
*/
|
|
1937
|
+
getCalendarEvents(): OverlapCalendarEvent[];
|
|
1938
|
+
/**
|
|
1939
|
+
* Gets current value of property {@link #getFirstDayOffset firstDayOffset}.
|
|
1940
|
+
*
|
|
1941
|
+
* Indicate how to offset the first day in regards to a Sunday (by default)
|
|
1942
|
+
*
|
|
1943
|
+
* Default value is `0`.
|
|
1944
|
+
*
|
|
1945
|
+
* @returns Value of property `firstDayOffset`
|
|
1946
|
+
*/
|
|
1947
|
+
getFirstDayOffset(): int;
|
|
1948
|
+
/**
|
|
1949
|
+
* Gets current value of property {@link #getShowOverlapIndicator showOverlapIndicator}.
|
|
1950
|
+
*
|
|
1951
|
+
* Do we want to display the overlap indicator
|
|
1952
|
+
*
|
|
1953
|
+
* Default value is `false`.
|
|
1954
|
+
*
|
|
1955
|
+
* @returns Value of property `showOverlapIndicator`
|
|
1956
|
+
*/
|
|
1957
|
+
getShowOverlapIndicator(): boolean;
|
|
1958
|
+
/**
|
|
1959
|
+
* Gets current value of property {@link #getStartDate startDate}.
|
|
1960
|
+
*
|
|
1961
|
+
* The first date to display for the calendar
|
|
1962
|
+
*
|
|
1963
|
+
* @returns Value of property `startDate`
|
|
1964
|
+
*/
|
|
1965
|
+
getStartDate(): string;
|
|
1966
|
+
/**
|
|
1967
|
+
* Gets current value of property {@link #getSwipeToNavigate swipeToNavigate}.
|
|
1968
|
+
*
|
|
1969
|
+
* Use swipe gesture to navigate
|
|
1970
|
+
*
|
|
1971
|
+
* Default value is `true`.
|
|
1972
|
+
*
|
|
1973
|
+
* @returns Value of property `swipeToNavigate`
|
|
1974
|
+
*/
|
|
1975
|
+
getSwipeToNavigate(): boolean;
|
|
1976
|
+
/**
|
|
1977
|
+
* Gets current value of property {@link #getVisible visible}.
|
|
1978
|
+
*
|
|
1979
|
+
* Indicates if we should render this component
|
|
1980
|
+
*
|
|
1981
|
+
* Default value is `true`.
|
|
1982
|
+
*
|
|
1983
|
+
* @returns Value of property `visible`
|
|
1984
|
+
*/
|
|
1985
|
+
getVisible(): boolean;
|
|
1986
|
+
/**
|
|
1987
|
+
* Gets current value of property {@link #getWeeksPerRow weeksPerRow}.
|
|
1988
|
+
*
|
|
1989
|
+
* Number of weeks
|
|
1990
|
+
*
|
|
1991
|
+
* Default value is `2`.
|
|
1992
|
+
*
|
|
1993
|
+
* @returns Value of property `weeksPerRow`
|
|
1994
|
+
*/
|
|
1995
|
+
getWeeksPerRow(): int;
|
|
1996
|
+
/**
|
|
1997
|
+
* Gets current value of property {@link #getWidth width}.
|
|
1998
|
+
*
|
|
1999
|
+
* The width of the calendar
|
|
2000
|
+
*
|
|
2001
|
+
* Default value is `'100%'`.
|
|
2002
|
+
*
|
|
2003
|
+
* @returns Value of property `width`
|
|
2004
|
+
*/
|
|
2005
|
+
getWidth(): CSSSize;
|
|
2006
|
+
/**
|
|
2007
|
+
* Checks for the provided `sap.me.OverlapCalendarEvent` in the aggregation {@link #getCalendarEvents calendarEvents}.
|
|
2008
|
+
* and returns its index if found or -1 otherwise.
|
|
2009
|
+
*
|
|
2010
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
2011
|
+
*/
|
|
2012
|
+
indexOfCalendarEvent(
|
|
2013
|
+
/**
|
|
2014
|
+
* The calendarEvent whose index is looked for
|
|
2015
|
+
*/
|
|
2016
|
+
oCalendarEvent: OverlapCalendarEvent
|
|
2017
|
+
): int;
|
|
2018
|
+
/**
|
|
2019
|
+
* Inserts a calendarEvent into the aggregation {@link #getCalendarEvents calendarEvents}.
|
|
2020
|
+
*
|
|
2021
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2022
|
+
*/
|
|
2023
|
+
insertCalendarEvent(
|
|
2024
|
+
/**
|
|
2025
|
+
* The calendarEvent to insert; if empty, nothing is inserted
|
|
2026
|
+
*/
|
|
2027
|
+
oCalendarEvent: OverlapCalendarEvent,
|
|
2028
|
+
/**
|
|
2029
|
+
* The `0`-based index the calendarEvent should be inserted at; for a negative value of `iIndex`, the calendarEvent
|
|
2030
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the calendarEvent
|
|
2031
|
+
* is inserted at the last position
|
|
2032
|
+
*/
|
|
2033
|
+
iIndex: int
|
|
2034
|
+
): this;
|
|
2035
|
+
|
|
2036
|
+
onAfterRendering(): void;
|
|
2037
|
+
|
|
2038
|
+
onBeforeRendering(): void;
|
|
2039
|
+
|
|
2040
|
+
onswipeleft(oEvent: jQuery.Event): void;
|
|
2041
|
+
|
|
2042
|
+
onswiperight(oEvent: jQuery.Event): void;
|
|
2043
|
+
/**
|
|
2044
|
+
* Removes all the controls from the aggregation {@link #getCalendarEvents calendarEvents}.
|
|
2045
|
+
*
|
|
2046
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
2047
|
+
*
|
|
2048
|
+
* @returns An array of the removed elements (might be empty)
|
|
2049
|
+
*/
|
|
2050
|
+
removeAllCalendarEvents(): OverlapCalendarEvent[];
|
|
2051
|
+
/**
|
|
2052
|
+
* Removes a calendarEvent from the aggregation {@link #getCalendarEvents calendarEvents}.
|
|
2053
|
+
*
|
|
2054
|
+
* @returns The removed calendarEvent or `null`
|
|
2055
|
+
*/
|
|
2056
|
+
removeCalendarEvent(
|
|
2057
|
+
/**
|
|
2058
|
+
* The calendarEvent to remove or its index or id
|
|
2059
|
+
*/
|
|
2060
|
+
vCalendarEvent: int | string | OverlapCalendarEvent
|
|
2061
|
+
): OverlapCalendarEvent | null;
|
|
2062
|
+
/**
|
|
2063
|
+
* Sets a new value for property {@link #getFirstDayOffset firstDayOffset}.
|
|
2064
|
+
*
|
|
2065
|
+
* Indicate how to offset the first day in regards to a Sunday (by default)
|
|
2066
|
+
*
|
|
2067
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2068
|
+
*
|
|
2069
|
+
* Default value is `0`.
|
|
2070
|
+
*
|
|
2071
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2072
|
+
*/
|
|
2073
|
+
setFirstDayOffset(
|
|
2074
|
+
/**
|
|
2075
|
+
* New value for property `firstDayOffset`
|
|
2076
|
+
*/
|
|
2077
|
+
iFirstDayOffset?: int
|
|
2078
|
+
): this;
|
|
2079
|
+
/**
|
|
2080
|
+
* Sets a new value for property {@link #getShowOverlapIndicator showOverlapIndicator}.
|
|
2081
|
+
*
|
|
2082
|
+
* Do we want to display the overlap indicator
|
|
2083
|
+
*
|
|
2084
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2085
|
+
*
|
|
2086
|
+
* Default value is `false`.
|
|
2087
|
+
*
|
|
2088
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2089
|
+
*/
|
|
2090
|
+
setShowOverlapIndicator(
|
|
2091
|
+
/**
|
|
2092
|
+
* New value for property `showOverlapIndicator`
|
|
2093
|
+
*/
|
|
2094
|
+
bShowOverlapIndicator?: boolean
|
|
2095
|
+
): this;
|
|
2096
|
+
|
|
2097
|
+
setStartDate(
|
|
2098
|
+
/**
|
|
2099
|
+
* The start date, expected toDateString.
|
|
2100
|
+
*/
|
|
2101
|
+
sDate: string | Date
|
|
2102
|
+
): void;
|
|
2103
|
+
|
|
2104
|
+
setSwipeToNavigate(bSwipe: boolean): void;
|
|
2105
|
+
/**
|
|
2106
|
+
* Sets a new value for property {@link #getVisible visible}.
|
|
2107
|
+
*
|
|
2108
|
+
* Indicates if we should render this component
|
|
2109
|
+
*
|
|
2110
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2111
|
+
*
|
|
2112
|
+
* Default value is `true`.
|
|
2113
|
+
*
|
|
2114
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2115
|
+
*/
|
|
2116
|
+
setVisible(
|
|
2117
|
+
/**
|
|
2118
|
+
* New value for property `visible`
|
|
2119
|
+
*/
|
|
2120
|
+
bVisible?: boolean
|
|
2121
|
+
): this;
|
|
2122
|
+
|
|
2123
|
+
setWeeksPerRow(
|
|
2124
|
+
/**
|
|
2125
|
+
* The integer number of weeks per row
|
|
2126
|
+
*/
|
|
2127
|
+
iWeeksPerRow: int
|
|
2128
|
+
): void;
|
|
2129
|
+
/**
|
|
2130
|
+
* Sets a new value for property {@link #getWidth width}.
|
|
2131
|
+
*
|
|
2132
|
+
* The width of the calendar
|
|
2133
|
+
*
|
|
2134
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2135
|
+
*
|
|
2136
|
+
* Default value is `'100%'`.
|
|
2137
|
+
*
|
|
2138
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2139
|
+
*/
|
|
2140
|
+
setWidth(
|
|
2141
|
+
/**
|
|
2142
|
+
* New value for property `width`
|
|
2143
|
+
*/
|
|
2144
|
+
sWidth?: CSSSize
|
|
2145
|
+
): this;
|
|
2146
|
+
}
|
|
2147
|
+
|
|
2148
|
+
export interface $OverlapCalendarSettings extends $ControlSettings {
|
|
2149
|
+
/**
|
|
2150
|
+
* The first date to display for the calendar
|
|
2151
|
+
*/
|
|
2152
|
+
startDate?: string | PropertyBindingInfo;
|
|
2153
|
+
|
|
2154
|
+
/**
|
|
2155
|
+
* Number of weeks
|
|
2156
|
+
*/
|
|
2157
|
+
weeksPerRow?: int | PropertyBindingInfo | `{${string}}`;
|
|
2158
|
+
|
|
2159
|
+
/**
|
|
2160
|
+
* Indicate how to offset the first day in regards to a Sunday (by default)
|
|
2161
|
+
*/
|
|
2162
|
+
firstDayOffset?: int | PropertyBindingInfo | `{${string}}`;
|
|
2163
|
+
|
|
2164
|
+
/**
|
|
2165
|
+
* Do we want to display the overlap indicator
|
|
2166
|
+
*/
|
|
2167
|
+
showOverlapIndicator?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
2168
|
+
|
|
2169
|
+
/**
|
|
2170
|
+
* Indicates if we should render this component
|
|
2171
|
+
*/
|
|
2172
|
+
visible?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
2173
|
+
|
|
2174
|
+
/**
|
|
2175
|
+
* Use swipe gesture to navigate
|
|
2176
|
+
*/
|
|
2177
|
+
swipeToNavigate?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
2178
|
+
|
|
2179
|
+
/**
|
|
2180
|
+
* The width of the calendar
|
|
2181
|
+
*/
|
|
2182
|
+
width?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
2183
|
+
|
|
2184
|
+
/**
|
|
2185
|
+
* The list of events to display in the calendar grid
|
|
2186
|
+
*/
|
|
2187
|
+
calendarEvents?:
|
|
2188
|
+
| OverlapCalendarEvent[]
|
|
2189
|
+
| OverlapCalendarEvent
|
|
2190
|
+
| AggregationBindingInfo
|
|
2191
|
+
| `{${string}}`;
|
|
2192
|
+
|
|
2193
|
+
/**
|
|
2194
|
+
* Indicates that we have reach the last week with data
|
|
2195
|
+
*/
|
|
2196
|
+
endOfData?: (oEvent: Event) => void;
|
|
2197
|
+
|
|
2198
|
+
/**
|
|
2199
|
+
* Triggered when the displayed dates change
|
|
2200
|
+
*/
|
|
2201
|
+
changeDate?: (oEvent: Event) => void;
|
|
2202
|
+
}
|
|
2203
|
+
}
|
|
2204
|
+
|
|
2205
|
+
declare module "sap/me/OverlapCalendarEvent" {
|
|
2206
|
+
import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
|
|
2207
|
+
|
|
2208
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
2209
|
+
|
|
2210
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
2211
|
+
|
|
2212
|
+
/**
|
|
2213
|
+
* @deprecated (since 1.34.0) - This control was experimental since 1.12. Please use the sap.ui.unified.CalendarAppointment
|
|
2214
|
+
* instead!
|
|
2215
|
+
*
|
|
2216
|
+
* Represent the data of an event for the overlap calendar
|
|
2217
|
+
*/
|
|
2218
|
+
export default class OverlapCalendarEvent extends UI5Element {
|
|
2219
|
+
/**
|
|
2220
|
+
* Constructor for a new OverlapCalendarEvent.
|
|
2221
|
+
*
|
|
2222
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2223
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2224
|
+
* of the syntax of the settings object.
|
|
2225
|
+
*/
|
|
2226
|
+
constructor(
|
|
2227
|
+
/**
|
|
2228
|
+
* initial settings for the new control
|
|
2229
|
+
*/
|
|
2230
|
+
mSettings?: $OverlapCalendarEventSettings
|
|
2231
|
+
);
|
|
2232
|
+
/**
|
|
2233
|
+
* Constructor for a new OverlapCalendarEvent.
|
|
2234
|
+
*
|
|
2235
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2236
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2237
|
+
* of the syntax of the settings object.
|
|
2238
|
+
*/
|
|
2239
|
+
constructor(
|
|
2240
|
+
/**
|
|
2241
|
+
* id for the new control, generated automatically if no id is given
|
|
2242
|
+
*/
|
|
2243
|
+
sId?: string,
|
|
2244
|
+
/**
|
|
2245
|
+
* initial settings for the new control
|
|
2246
|
+
*/
|
|
2247
|
+
mSettings?: $OverlapCalendarEventSettings
|
|
2248
|
+
);
|
|
2249
|
+
|
|
2250
|
+
/**
|
|
2251
|
+
* Creates a new subclass of class sap.me.OverlapCalendarEvent with name `sClassName` and enriches it with
|
|
2252
|
+
* the information contained in `oClassInfo`.
|
|
2253
|
+
*
|
|
2254
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
2255
|
+
*
|
|
2256
|
+
* @returns Created class / constructor function
|
|
2257
|
+
*/
|
|
2258
|
+
static extend<T extends Record<string, unknown>>(
|
|
2259
|
+
/**
|
|
2260
|
+
* Name of the class being created
|
|
2261
|
+
*/
|
|
2262
|
+
sClassName: string,
|
|
2263
|
+
/**
|
|
2264
|
+
* Object literal with information about the class
|
|
2265
|
+
*/
|
|
2266
|
+
oClassInfo?: sap.ClassInfo<T, OverlapCalendarEvent>,
|
|
2267
|
+
/**
|
|
2268
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2269
|
+
* used by this class
|
|
2270
|
+
*/
|
|
2271
|
+
FNMetaImpl?: Function
|
|
2272
|
+
): Function;
|
|
2273
|
+
/**
|
|
2274
|
+
* Returns a metadata object for class sap.me.OverlapCalendarEvent.
|
|
2275
|
+
*
|
|
2276
|
+
* @returns Metadata object describing this class
|
|
2277
|
+
*/
|
|
2278
|
+
static getMetadata(): ElementMetadata;
|
|
2279
|
+
/**
|
|
2280
|
+
* Binds property {@link #getEndDay endDay} to model data.
|
|
2281
|
+
*
|
|
2282
|
+
* See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description
|
|
2283
|
+
* of the possible properties of `oBindingInfo`
|
|
2284
|
+
*
|
|
2285
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2286
|
+
*/
|
|
2287
|
+
bindEndDay(
|
|
2288
|
+
/**
|
|
2289
|
+
* The binding information
|
|
2290
|
+
*/
|
|
2291
|
+
oBindingInfo: PropertyBindingInfo
|
|
2292
|
+
): this;
|
|
2293
|
+
/**
|
|
2294
|
+
* Binds property {@link #getHalfDay halfDay} to model data.
|
|
2295
|
+
*
|
|
2296
|
+
* See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description
|
|
2297
|
+
* of the possible properties of `oBindingInfo`
|
|
2298
|
+
*
|
|
2299
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2300
|
+
*/
|
|
2301
|
+
bindHalfDay(
|
|
2302
|
+
/**
|
|
2303
|
+
* The binding information
|
|
2304
|
+
*/
|
|
2305
|
+
oBindingInfo: PropertyBindingInfo
|
|
2306
|
+
): this;
|
|
2307
|
+
/**
|
|
2308
|
+
* Binds property {@link #getName name} to model data.
|
|
2309
|
+
*
|
|
2310
|
+
* See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description
|
|
2311
|
+
* of the possible properties of `oBindingInfo`
|
|
2312
|
+
*
|
|
2313
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2314
|
+
*/
|
|
2315
|
+
bindName(
|
|
2316
|
+
/**
|
|
2317
|
+
* The binding information
|
|
2318
|
+
*/
|
|
2319
|
+
oBindingInfo: PropertyBindingInfo
|
|
2320
|
+
): this;
|
|
2321
|
+
/**
|
|
2322
|
+
* Binds property {@link #getRelevant relevant} to model data.
|
|
2323
|
+
*
|
|
2324
|
+
* See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description
|
|
2325
|
+
* of the possible properties of `oBindingInfo`
|
|
2326
|
+
*
|
|
2327
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2328
|
+
*/
|
|
2329
|
+
bindRelevant(
|
|
2330
|
+
/**
|
|
2331
|
+
* The binding information
|
|
2332
|
+
*/
|
|
2333
|
+
oBindingInfo: PropertyBindingInfo
|
|
2334
|
+
): this;
|
|
2335
|
+
/**
|
|
2336
|
+
* Binds property {@link #getRow row} to model data.
|
|
2337
|
+
*
|
|
2338
|
+
* See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description
|
|
2339
|
+
* of the possible properties of `oBindingInfo`
|
|
2340
|
+
*
|
|
2341
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2342
|
+
*/
|
|
2343
|
+
bindRow(
|
|
2344
|
+
/**
|
|
2345
|
+
* The binding information
|
|
2346
|
+
*/
|
|
2347
|
+
oBindingInfo: PropertyBindingInfo
|
|
2348
|
+
): this;
|
|
2349
|
+
/**
|
|
2350
|
+
* Binds property {@link #getStartDay startDay} to model data.
|
|
2351
|
+
*
|
|
2352
|
+
* See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description
|
|
2353
|
+
* of the possible properties of `oBindingInfo`
|
|
2354
|
+
*
|
|
2355
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2356
|
+
*/
|
|
2357
|
+
bindStartDay(
|
|
2358
|
+
/**
|
|
2359
|
+
* The binding information
|
|
2360
|
+
*/
|
|
2361
|
+
oBindingInfo: PropertyBindingInfo
|
|
2362
|
+
): this;
|
|
2363
|
+
/**
|
|
2364
|
+
* Binds property {@link #getType type} to model data.
|
|
2365
|
+
*
|
|
2366
|
+
* See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description
|
|
2367
|
+
* of the possible properties of `oBindingInfo`
|
|
2368
|
+
*
|
|
2369
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2370
|
+
*/
|
|
2371
|
+
bindType(
|
|
2372
|
+
/**
|
|
2373
|
+
* The binding information
|
|
2374
|
+
*/
|
|
2375
|
+
oBindingInfo: PropertyBindingInfo
|
|
2376
|
+
): this;
|
|
2377
|
+
/**
|
|
2378
|
+
* Binds property {@link #getTypeName typeName} to model data.
|
|
2379
|
+
*
|
|
2380
|
+
* See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description
|
|
2381
|
+
* of the possible properties of `oBindingInfo`
|
|
2382
|
+
*
|
|
2383
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2384
|
+
*/
|
|
2385
|
+
bindTypeName(
|
|
2386
|
+
/**
|
|
2387
|
+
* The binding information
|
|
2388
|
+
*/
|
|
2389
|
+
oBindingInfo: PropertyBindingInfo
|
|
2390
|
+
): this;
|
|
2391
|
+
/**
|
|
2392
|
+
* Gets current value of property {@link #getEndDay endDay}.
|
|
2393
|
+
*
|
|
2394
|
+
* Last day of the event
|
|
2395
|
+
*
|
|
2396
|
+
* @returns Value of property `endDay`
|
|
2397
|
+
*/
|
|
2398
|
+
getEndDay(): string;
|
|
2399
|
+
/**
|
|
2400
|
+
* Gets current value of property {@link #getHalfDay halfDay}.
|
|
2401
|
+
*
|
|
2402
|
+
* Is this half a day
|
|
2403
|
+
*
|
|
2404
|
+
* Default value is `false`.
|
|
2405
|
+
*
|
|
2406
|
+
* @returns Value of property `halfDay`
|
|
2407
|
+
*/
|
|
2408
|
+
getHalfDay(): boolean;
|
|
2409
|
+
/**
|
|
2410
|
+
* Gets current value of property {@link #getName name}.
|
|
2411
|
+
*
|
|
2412
|
+
* Name of the row
|
|
2413
|
+
*
|
|
2414
|
+
* @returns Value of property `name`
|
|
2415
|
+
*/
|
|
2416
|
+
getName(): string;
|
|
2417
|
+
/**
|
|
2418
|
+
* Gets current value of property {@link #getRelevant relevant}.
|
|
2419
|
+
*
|
|
2420
|
+
* Indicates if this elements is relevant to be consider in the overlap
|
|
2421
|
+
*
|
|
2422
|
+
* @returns Value of property `relevant`
|
|
2423
|
+
*/
|
|
2424
|
+
getRelevant(): boolean;
|
|
2425
|
+
/**
|
|
2426
|
+
* Gets current value of property {@link #getRow row}.
|
|
2427
|
+
*
|
|
2428
|
+
* Id of the row on which to place this event
|
|
2429
|
+
*
|
|
2430
|
+
* Default value is `-1`.
|
|
2431
|
+
*
|
|
2432
|
+
* @returns Value of property `row`
|
|
2433
|
+
*/
|
|
2434
|
+
getRow(): int;
|
|
2435
|
+
/**
|
|
2436
|
+
* Gets current value of property {@link #getStartDay startDay}.
|
|
2437
|
+
*
|
|
2438
|
+
* The first day of the event
|
|
2439
|
+
*
|
|
2440
|
+
* @returns Value of property `startDay`
|
|
2441
|
+
*/
|
|
2442
|
+
getStartDay(): string;
|
|
2443
|
+
/**
|
|
2444
|
+
* Gets current value of property {@link #getType type}.
|
|
2445
|
+
*
|
|
2446
|
+
* Type of the event. Display in the second label (no overlap)
|
|
2447
|
+
*
|
|
2448
|
+
* @returns Value of property `type`
|
|
2449
|
+
*/
|
|
2450
|
+
getType(): string;
|
|
2451
|
+
/**
|
|
2452
|
+
* Gets current value of property {@link #getTypeName typeName}.
|
|
2453
|
+
*
|
|
2454
|
+
* The CSS class to use
|
|
2455
|
+
*
|
|
2456
|
+
* @returns Value of property `typeName`
|
|
2457
|
+
*/
|
|
2458
|
+
getTypeName(): string;
|
|
2459
|
+
/**
|
|
2460
|
+
* Sets a new value for property {@link #getEndDay endDay}.
|
|
2461
|
+
*
|
|
2462
|
+
* Last day of the event
|
|
2463
|
+
*
|
|
2464
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2465
|
+
*
|
|
2466
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2467
|
+
*/
|
|
2468
|
+
setEndDay(
|
|
2469
|
+
/**
|
|
2470
|
+
* New value for property `endDay`
|
|
2471
|
+
*/
|
|
2472
|
+
sEndDay?: string
|
|
2473
|
+
): this;
|
|
2474
|
+
/**
|
|
2475
|
+
* Sets a new value for property {@link #getHalfDay halfDay}.
|
|
2476
|
+
*
|
|
2477
|
+
* Is this half a day
|
|
2478
|
+
*
|
|
2479
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2480
|
+
*
|
|
2481
|
+
* Default value is `false`.
|
|
2482
|
+
*
|
|
2483
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2484
|
+
*/
|
|
2485
|
+
setHalfDay(
|
|
2486
|
+
/**
|
|
2487
|
+
* New value for property `halfDay`
|
|
2488
|
+
*/
|
|
2489
|
+
bHalfDay?: boolean
|
|
2490
|
+
): this;
|
|
2491
|
+
/**
|
|
2492
|
+
* Sets a new value for property {@link #getName name}.
|
|
2493
|
+
*
|
|
2494
|
+
* Name of the row
|
|
2495
|
+
*
|
|
2496
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2497
|
+
*
|
|
2498
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2499
|
+
*/
|
|
2500
|
+
setName(
|
|
2501
|
+
/**
|
|
2502
|
+
* New value for property `name`
|
|
2503
|
+
*/
|
|
2504
|
+
sName?: string
|
|
2505
|
+
): this;
|
|
2506
|
+
/**
|
|
2507
|
+
* Sets a new value for property {@link #getRelevant relevant}.
|
|
2508
|
+
*
|
|
2509
|
+
* Indicates if this elements is relevant to be consider in the overlap
|
|
2510
|
+
*
|
|
2511
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2512
|
+
*
|
|
2513
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2514
|
+
*/
|
|
2515
|
+
setRelevant(
|
|
2516
|
+
/**
|
|
2517
|
+
* New value for property `relevant`
|
|
2518
|
+
*/
|
|
2519
|
+
bRelevant?: boolean
|
|
2520
|
+
): this;
|
|
2521
|
+
/**
|
|
2522
|
+
* Sets a new value for property {@link #getRow row}.
|
|
2523
|
+
*
|
|
2524
|
+
* Id of the row on which to place this event
|
|
2525
|
+
*
|
|
2526
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2527
|
+
*
|
|
2528
|
+
* Default value is `-1`.
|
|
2529
|
+
*
|
|
2530
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2531
|
+
*/
|
|
2532
|
+
setRow(
|
|
2533
|
+
/**
|
|
2534
|
+
* New value for property `row`
|
|
2535
|
+
*/
|
|
2536
|
+
iRow?: int
|
|
2537
|
+
): this;
|
|
2538
|
+
/**
|
|
2539
|
+
* Sets a new value for property {@link #getStartDay startDay}.
|
|
2540
|
+
*
|
|
2541
|
+
* The first day of the event
|
|
2542
|
+
*
|
|
2543
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2544
|
+
*
|
|
2545
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2546
|
+
*/
|
|
2547
|
+
setStartDay(
|
|
2548
|
+
/**
|
|
2549
|
+
* New value for property `startDay`
|
|
2550
|
+
*/
|
|
2551
|
+
sStartDay?: string
|
|
2552
|
+
): this;
|
|
2553
|
+
/**
|
|
2554
|
+
* Sets a new value for property {@link #getType type}.
|
|
2555
|
+
*
|
|
2556
|
+
* Type of the event. Display in the second label (no overlap)
|
|
2557
|
+
*
|
|
2558
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2559
|
+
*
|
|
2560
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2561
|
+
*/
|
|
2562
|
+
setType(
|
|
2563
|
+
/**
|
|
2564
|
+
* New value for property `type`
|
|
2565
|
+
*/
|
|
2566
|
+
sType?: string
|
|
2567
|
+
): this;
|
|
2568
|
+
/**
|
|
2569
|
+
* Sets a new value for property {@link #getTypeName typeName}.
|
|
2570
|
+
*
|
|
2571
|
+
* The CSS class to use
|
|
2572
|
+
*
|
|
2573
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2574
|
+
*
|
|
2575
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2576
|
+
*/
|
|
2577
|
+
setTypeName(
|
|
2578
|
+
/**
|
|
2579
|
+
* New value for property `typeName`
|
|
2580
|
+
*/
|
|
2581
|
+
sTypeName?: string
|
|
2582
|
+
): this;
|
|
2583
|
+
/**
|
|
2584
|
+
* Unbinds property {@link #getEndDay endDay} from model data.
|
|
2585
|
+
*
|
|
2586
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2587
|
+
*/
|
|
2588
|
+
unbindEndDay(): this;
|
|
2589
|
+
/**
|
|
2590
|
+
* Unbinds property {@link #getHalfDay halfDay} from model data.
|
|
2591
|
+
*
|
|
2592
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2593
|
+
*/
|
|
2594
|
+
unbindHalfDay(): this;
|
|
2595
|
+
/**
|
|
2596
|
+
* Unbinds property {@link #getName name} from model data.
|
|
2597
|
+
*
|
|
2598
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2599
|
+
*/
|
|
2600
|
+
unbindName(): this;
|
|
2601
|
+
/**
|
|
2602
|
+
* Unbinds property {@link #getRelevant relevant} from model data.
|
|
2603
|
+
*
|
|
2604
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2605
|
+
*/
|
|
2606
|
+
unbindRelevant(): this;
|
|
2607
|
+
/**
|
|
2608
|
+
* Unbinds property {@link #getRow row} from model data.
|
|
2609
|
+
*
|
|
2610
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2611
|
+
*/
|
|
2612
|
+
unbindRow(): this;
|
|
2613
|
+
/**
|
|
2614
|
+
* Unbinds property {@link #getStartDay startDay} from model data.
|
|
2615
|
+
*
|
|
2616
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2617
|
+
*/
|
|
2618
|
+
unbindStartDay(): this;
|
|
2619
|
+
/**
|
|
2620
|
+
* Unbinds property {@link #getType type} from model data.
|
|
2621
|
+
*
|
|
2622
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2623
|
+
*/
|
|
2624
|
+
unbindType(): this;
|
|
2625
|
+
/**
|
|
2626
|
+
* Unbinds property {@link #getTypeName typeName} from model data.
|
|
2627
|
+
*
|
|
2628
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2629
|
+
*/
|
|
2630
|
+
unbindTypeName(): this;
|
|
2631
|
+
}
|
|
2632
|
+
|
|
2633
|
+
export interface $OverlapCalendarEventSettings extends $ElementSettings {
|
|
2634
|
+
/**
|
|
2635
|
+
* The first day of the event
|
|
2636
|
+
*/
|
|
2637
|
+
startDay?: string | PropertyBindingInfo;
|
|
2638
|
+
|
|
2639
|
+
/**
|
|
2640
|
+
* Last day of the event
|
|
2641
|
+
*/
|
|
2642
|
+
endDay?: string | PropertyBindingInfo;
|
|
2643
|
+
|
|
2644
|
+
/**
|
|
2645
|
+
* Indicates if this elements is relevant to be consider in the overlap
|
|
2646
|
+
*/
|
|
2647
|
+
relevant?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
2648
|
+
|
|
2649
|
+
/**
|
|
2650
|
+
* Type of the event. Display in the second label (no overlap)
|
|
2651
|
+
*/
|
|
2652
|
+
type?: string | PropertyBindingInfo;
|
|
2653
|
+
|
|
2654
|
+
/**
|
|
2655
|
+
* The CSS class to use
|
|
2656
|
+
*/
|
|
2657
|
+
typeName?: string | PropertyBindingInfo;
|
|
2658
|
+
|
|
2659
|
+
/**
|
|
2660
|
+
* Is this half a day
|
|
2661
|
+
*/
|
|
2662
|
+
halfDay?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
2663
|
+
|
|
2664
|
+
/**
|
|
2665
|
+
* Id of the row on which to place this event
|
|
2666
|
+
*/
|
|
2667
|
+
row?: int | PropertyBindingInfo | `{${string}}`;
|
|
2668
|
+
|
|
2669
|
+
/**
|
|
2670
|
+
* Name of the row
|
|
2671
|
+
*/
|
|
2672
|
+
name?: string | PropertyBindingInfo;
|
|
2673
|
+
}
|
|
2674
|
+
}
|
|
2675
|
+
|
|
2676
|
+
declare module "sap/me/ProgressIndicator" {
|
|
2677
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
2678
|
+
|
|
2679
|
+
import { BarColor, CSSSize } from "sap/ui/core/library";
|
|
2680
|
+
|
|
2681
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
2682
|
+
|
|
2683
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
2684
|
+
|
|
2685
|
+
/**
|
|
2686
|
+
* @deprecated (since 1.14) - This control is replaced by sap.m.ProgressIndicator
|
|
2687
|
+
*
|
|
2688
|
+
* Shows the progress of a process in a graphical way. The indicator can be displayed with or without numerical
|
|
2689
|
+
* values. The filling can be displayed in color only, or additionally with the percentage rate. The indicator
|
|
2690
|
+
* status can be interactive.
|
|
2691
|
+
*/
|
|
2692
|
+
export default class ProgressIndicator extends Control {
|
|
2693
|
+
/**
|
|
2694
|
+
* Constructor for a new ProgressIndicator.
|
|
2695
|
+
*
|
|
2696
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2697
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2698
|
+
* of the syntax of the settings object.
|
|
2699
|
+
*/
|
|
2700
|
+
constructor(
|
|
2701
|
+
/**
|
|
2702
|
+
* initial settings for the new control
|
|
2703
|
+
*/
|
|
2704
|
+
mSettings?: $ProgressIndicatorSettings
|
|
2705
|
+
);
|
|
2706
|
+
/**
|
|
2707
|
+
* Constructor for a new ProgressIndicator.
|
|
2708
|
+
*
|
|
2709
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2710
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2711
|
+
* of the syntax of the settings object.
|
|
2712
|
+
*/
|
|
2713
|
+
constructor(
|
|
2714
|
+
/**
|
|
2715
|
+
* id for the new control, generated automatically if no id is given
|
|
2716
|
+
*/
|
|
2717
|
+
sId?: string,
|
|
2718
|
+
/**
|
|
2719
|
+
* initial settings for the new control
|
|
2720
|
+
*/
|
|
2721
|
+
mSettings?: $ProgressIndicatorSettings
|
|
2722
|
+
);
|
|
2723
|
+
|
|
2724
|
+
/**
|
|
2725
|
+
* Creates a new subclass of class sap.me.ProgressIndicator with name `sClassName` and enriches it with
|
|
2726
|
+
* the information contained in `oClassInfo`.
|
|
2727
|
+
*
|
|
2728
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
2729
|
+
*
|
|
2730
|
+
* @returns Created class / constructor function
|
|
2731
|
+
*/
|
|
2732
|
+
static extend<T extends Record<string, unknown>>(
|
|
2733
|
+
/**
|
|
2734
|
+
* Name of the class being created
|
|
2735
|
+
*/
|
|
2736
|
+
sClassName: string,
|
|
2737
|
+
/**
|
|
2738
|
+
* Object literal with information about the class
|
|
2739
|
+
*/
|
|
2740
|
+
oClassInfo?: sap.ClassInfo<T, ProgressIndicator>,
|
|
2741
|
+
/**
|
|
2742
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2743
|
+
* used by this class
|
|
2744
|
+
*/
|
|
2745
|
+
FNMetaImpl?: Function
|
|
2746
|
+
): Function;
|
|
2747
|
+
/**
|
|
2748
|
+
* Returns a metadata object for class sap.me.ProgressIndicator.
|
|
2749
|
+
*
|
|
2750
|
+
* @returns Metadata object describing this class
|
|
2751
|
+
*/
|
|
2752
|
+
static getMetadata(): ElementMetadata;
|
|
2753
|
+
/**
|
|
2754
|
+
* Gets current value of property {@link #getBarColor barColor}.
|
|
2755
|
+
*
|
|
2756
|
+
* The color of the bar. Enumeration sap.ui.core.BarColor provides CRITICAL (yellow), NEGATIVE (red), POSITIVE
|
|
2757
|
+
* (green), NEUTRAL (blue) (default value).
|
|
2758
|
+
*
|
|
2759
|
+
* Default value is `NEUTRAL`.
|
|
2760
|
+
*
|
|
2761
|
+
* @returns Value of property `barColor`
|
|
2762
|
+
*/
|
|
2763
|
+
getBarColor(): BarColor | keyof typeof BarColor;
|
|
2764
|
+
/**
|
|
2765
|
+
* Gets current value of property {@link #getDisplayValue displayValue}.
|
|
2766
|
+
*
|
|
2767
|
+
* The text value to be displayed in the bar.
|
|
2768
|
+
*
|
|
2769
|
+
* Default value is `'0%'`.
|
|
2770
|
+
*
|
|
2771
|
+
* @returns Value of property `displayValue`
|
|
2772
|
+
*/
|
|
2773
|
+
getDisplayValue(): string;
|
|
2774
|
+
/**
|
|
2775
|
+
* Gets current value of property {@link #getEnabled enabled}.
|
|
2776
|
+
*
|
|
2777
|
+
* Switches enabled state of the control. Disabled fields have different colors, and cannot be focused.
|
|
2778
|
+
*
|
|
2779
|
+
* Default value is `true`.
|
|
2780
|
+
*
|
|
2781
|
+
* @returns Value of property `enabled`
|
|
2782
|
+
*/
|
|
2783
|
+
getEnabled(): boolean;
|
|
2784
|
+
/**
|
|
2785
|
+
* Gets current value of property {@link #getPercentValue percentValue}.
|
|
2786
|
+
*
|
|
2787
|
+
* The numerical value for the displayed length of the progress bar.
|
|
2788
|
+
*
|
|
2789
|
+
* Default value is `0`.
|
|
2790
|
+
*
|
|
2791
|
+
* @returns Value of property `percentValue`
|
|
2792
|
+
*/
|
|
2793
|
+
getPercentValue(): int;
|
|
2794
|
+
/**
|
|
2795
|
+
* Gets current value of property {@link #getShowValue showValue}.
|
|
2796
|
+
*
|
|
2797
|
+
* Specifies whether the current value shall be rendered inside the bar.
|
|
2798
|
+
*
|
|
2799
|
+
* Default value is `true`.
|
|
2800
|
+
*
|
|
2801
|
+
* @returns Value of property `showValue`
|
|
2802
|
+
*/
|
|
2803
|
+
getShowValue(): boolean;
|
|
2804
|
+
/**
|
|
2805
|
+
* Gets current value of property {@link #getVisible visible}.
|
|
2806
|
+
*
|
|
2807
|
+
* Invisible controls are not rendered
|
|
2808
|
+
*
|
|
2809
|
+
* Default value is `true`.
|
|
2810
|
+
*
|
|
2811
|
+
* @returns Value of property `visible`
|
|
2812
|
+
*/
|
|
2813
|
+
getVisible(): boolean;
|
|
2814
|
+
/**
|
|
2815
|
+
* Gets current value of property {@link #getWidth width}.
|
|
2816
|
+
*
|
|
2817
|
+
* The width of the control.
|
|
2818
|
+
*
|
|
2819
|
+
* Default value is `'100%'`.
|
|
2820
|
+
*
|
|
2821
|
+
* @returns Value of property `width`
|
|
2822
|
+
*/
|
|
2823
|
+
getWidth(): CSSSize;
|
|
2824
|
+
/**
|
|
2825
|
+
* Sets a new value for property {@link #getBarColor barColor}.
|
|
2826
|
+
*
|
|
2827
|
+
* The color of the bar. Enumeration sap.ui.core.BarColor provides CRITICAL (yellow), NEGATIVE (red), POSITIVE
|
|
2828
|
+
* (green), NEUTRAL (blue) (default value).
|
|
2829
|
+
*
|
|
2830
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2831
|
+
*
|
|
2832
|
+
* Default value is `NEUTRAL`.
|
|
2833
|
+
*
|
|
2834
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2835
|
+
*/
|
|
2836
|
+
setBarColor(
|
|
2837
|
+
/**
|
|
2838
|
+
* New value for property `barColor`
|
|
2839
|
+
*/
|
|
2840
|
+
sBarColor?: BarColor | keyof typeof BarColor
|
|
2841
|
+
): this;
|
|
2842
|
+
/**
|
|
2843
|
+
* Sets a new value for property {@link #getDisplayValue displayValue}.
|
|
2844
|
+
*
|
|
2845
|
+
* The text value to be displayed in the bar.
|
|
2846
|
+
*
|
|
2847
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2848
|
+
*
|
|
2849
|
+
* Default value is `'0%'`.
|
|
2850
|
+
*
|
|
2851
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2852
|
+
*/
|
|
2853
|
+
setDisplayValue(
|
|
2854
|
+
/**
|
|
2855
|
+
* New value for property `displayValue`
|
|
2856
|
+
*/
|
|
2857
|
+
sDisplayValue?: string
|
|
2858
|
+
): this;
|
|
2859
|
+
/**
|
|
2860
|
+
* Sets a new value for property {@link #getEnabled enabled}.
|
|
2861
|
+
*
|
|
2862
|
+
* Switches enabled state of the control. Disabled fields have different colors, and cannot be focused.
|
|
2863
|
+
*
|
|
2864
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2865
|
+
*
|
|
2866
|
+
* Default value is `true`.
|
|
2867
|
+
*
|
|
2868
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2869
|
+
*/
|
|
2870
|
+
setEnabled(
|
|
2871
|
+
/**
|
|
2872
|
+
* New value for property `enabled`
|
|
2873
|
+
*/
|
|
2874
|
+
bEnabled?: boolean
|
|
2875
|
+
): this;
|
|
2876
|
+
/**
|
|
2877
|
+
* Property setter for the PercentValue A new rendering is not necessary, only the bar has to be moved.
|
|
2878
|
+
*
|
|
2879
|
+
* @returns `this` to allow method chaining
|
|
2880
|
+
*/
|
|
2881
|
+
setPercentValue(iPercentValue: undefined): this;
|
|
2882
|
+
/**
|
|
2883
|
+
* Sets a new value for property {@link #getShowValue showValue}.
|
|
2884
|
+
*
|
|
2885
|
+
* Specifies whether the current value shall be rendered inside the bar.
|
|
2886
|
+
*
|
|
2887
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2888
|
+
*
|
|
2889
|
+
* Default value is `true`.
|
|
2890
|
+
*
|
|
2891
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2892
|
+
*/
|
|
2893
|
+
setShowValue(
|
|
2894
|
+
/**
|
|
2895
|
+
* New value for property `showValue`
|
|
2896
|
+
*/
|
|
2897
|
+
bShowValue?: boolean
|
|
2898
|
+
): this;
|
|
2899
|
+
/**
|
|
2900
|
+
* Sets a new value for property {@link #getVisible visible}.
|
|
2901
|
+
*
|
|
2902
|
+
* Invisible controls are not rendered
|
|
2903
|
+
*
|
|
2904
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2905
|
+
*
|
|
2906
|
+
* Default value is `true`.
|
|
2907
|
+
*
|
|
2908
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2909
|
+
*/
|
|
2910
|
+
setVisible(
|
|
2911
|
+
/**
|
|
2912
|
+
* New value for property `visible`
|
|
2913
|
+
*/
|
|
2914
|
+
bVisible?: boolean
|
|
2915
|
+
): this;
|
|
2916
|
+
/**
|
|
2917
|
+
* Sets a new value for property {@link #getWidth width}.
|
|
2918
|
+
*
|
|
2919
|
+
* The width of the control.
|
|
2920
|
+
*
|
|
2921
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2922
|
+
*
|
|
2923
|
+
* Default value is `'100%'`.
|
|
2924
|
+
*
|
|
2925
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2926
|
+
*/
|
|
2927
|
+
setWidth(
|
|
2928
|
+
/**
|
|
2929
|
+
* New value for property `width`
|
|
2930
|
+
*/
|
|
2931
|
+
sWidth?: CSSSize
|
|
2932
|
+
): this;
|
|
2933
|
+
}
|
|
2934
|
+
|
|
2935
|
+
export interface $ProgressIndicatorSettings extends $ControlSettings {
|
|
2936
|
+
/**
|
|
2937
|
+
* Invisible controls are not rendered
|
|
2938
|
+
*/
|
|
2939
|
+
visible?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
2940
|
+
|
|
2941
|
+
/**
|
|
2942
|
+
* Switches enabled state of the control. Disabled fields have different colors, and cannot be focused.
|
|
2943
|
+
*/
|
|
2944
|
+
enabled?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
2945
|
+
|
|
2946
|
+
/**
|
|
2947
|
+
* The color of the bar. Enumeration sap.ui.core.BarColor provides CRITICAL (yellow), NEGATIVE (red), POSITIVE
|
|
2948
|
+
* (green), NEUTRAL (blue) (default value).
|
|
2949
|
+
*/
|
|
2950
|
+
barColor?:
|
|
2951
|
+
| (BarColor | keyof typeof BarColor)
|
|
2952
|
+
| PropertyBindingInfo
|
|
2953
|
+
| `{${string}}`;
|
|
2954
|
+
|
|
2955
|
+
/**
|
|
2956
|
+
* The text value to be displayed in the bar.
|
|
2957
|
+
*/
|
|
2958
|
+
displayValue?: string | PropertyBindingInfo;
|
|
2959
|
+
|
|
2960
|
+
/**
|
|
2961
|
+
* The numerical value for the displayed length of the progress bar.
|
|
2962
|
+
*/
|
|
2963
|
+
percentValue?: int | PropertyBindingInfo | `{${string}}`;
|
|
2964
|
+
|
|
2965
|
+
/**
|
|
2966
|
+
* Specifies whether the current value shall be rendered inside the bar.
|
|
2967
|
+
*/
|
|
2968
|
+
showValue?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
2969
|
+
|
|
2970
|
+
/**
|
|
2971
|
+
* The width of the control.
|
|
2972
|
+
*/
|
|
2973
|
+
width?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
2974
|
+
}
|
|
2975
|
+
}
|
|
2976
|
+
|
|
2977
|
+
declare module "sap/me/TabContainer" {
|
|
2978
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
2979
|
+
|
|
2980
|
+
import Event from "sap/ui/base/Event";
|
|
2981
|
+
|
|
2982
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
2983
|
+
|
|
2984
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
2985
|
+
|
|
2986
|
+
/**
|
|
2987
|
+
* @deprecated (since 1.15.0) - The functionality of this control is merged with the sap.m.IconTabBar. Please
|
|
2988
|
+
* use the sap.m.IconTabBar instead! This control will not be supported anymore.
|
|
2989
|
+
*
|
|
2990
|
+
* The TabContainer allow to stack 1 to 4 contents in a view with corresponding icons
|
|
2991
|
+
*/
|
|
2992
|
+
export default class TabContainer extends Control {
|
|
2993
|
+
/**
|
|
2994
|
+
* Constructor for a new TabContainer.
|
|
2995
|
+
*
|
|
2996
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2997
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2998
|
+
* of the syntax of the settings object.
|
|
2999
|
+
*/
|
|
3000
|
+
constructor(
|
|
3001
|
+
/**
|
|
3002
|
+
* initial settings for the new control
|
|
3003
|
+
*/
|
|
3004
|
+
mSettings?: $TabContainerSettings
|
|
3005
|
+
);
|
|
3006
|
+
/**
|
|
3007
|
+
* Constructor for a new TabContainer.
|
|
3008
|
+
*
|
|
3009
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3010
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3011
|
+
* of the syntax of the settings object.
|
|
3012
|
+
*/
|
|
3013
|
+
constructor(
|
|
3014
|
+
/**
|
|
3015
|
+
* id for the new control, generated automatically if no id is given
|
|
3016
|
+
*/
|
|
3017
|
+
sId?: string,
|
|
3018
|
+
/**
|
|
3019
|
+
* initial settings for the new control
|
|
3020
|
+
*/
|
|
3021
|
+
mSettings?: $TabContainerSettings
|
|
3022
|
+
);
|
|
3023
|
+
|
|
3024
|
+
/**
|
|
3025
|
+
* Creates a new subclass of class sap.me.TabContainer with name `sClassName` and enriches it with the information
|
|
3026
|
+
* contained in `oClassInfo`.
|
|
3027
|
+
*
|
|
3028
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
3029
|
+
*
|
|
3030
|
+
* @returns Created class / constructor function
|
|
3031
|
+
*/
|
|
3032
|
+
static extend<T extends Record<string, unknown>>(
|
|
3033
|
+
/**
|
|
3034
|
+
* Name of the class being created
|
|
3035
|
+
*/
|
|
3036
|
+
sClassName: string,
|
|
3037
|
+
/**
|
|
3038
|
+
* Object literal with information about the class
|
|
3039
|
+
*/
|
|
3040
|
+
oClassInfo?: sap.ClassInfo<T, TabContainer>,
|
|
3041
|
+
/**
|
|
3042
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
3043
|
+
* used by this class
|
|
3044
|
+
*/
|
|
3045
|
+
FNMetaImpl?: Function
|
|
3046
|
+
): Function;
|
|
3047
|
+
/**
|
|
3048
|
+
* Returns a metadata object for class sap.me.TabContainer.
|
|
3049
|
+
*
|
|
3050
|
+
* @returns Metadata object describing this class
|
|
3051
|
+
*/
|
|
3052
|
+
static getMetadata(): ElementMetadata;
|
|
3053
|
+
/**
|
|
3054
|
+
* Attaches event handler `fnFunction` to the {@link #event:collapse collapse} event of this `sap.me.TabContainer`.
|
|
3055
|
+
*
|
|
3056
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3057
|
+
* otherwise it will be bound to this `sap.me.TabContainer` itself.
|
|
3058
|
+
*
|
|
3059
|
+
* Indicates that the tab will collapse
|
|
3060
|
+
*
|
|
3061
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3062
|
+
*/
|
|
3063
|
+
attachCollapse(
|
|
3064
|
+
/**
|
|
3065
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
3066
|
+
* object when firing the event
|
|
3067
|
+
*/
|
|
3068
|
+
oData: object,
|
|
3069
|
+
/**
|
|
3070
|
+
* The function to be called when the event occurs
|
|
3071
|
+
*/
|
|
3072
|
+
fnFunction: (p1: Event) => void,
|
|
3073
|
+
/**
|
|
3074
|
+
* Context object to call the event handler with. Defaults to this `sap.me.TabContainer` itself
|
|
3075
|
+
*/
|
|
3076
|
+
oListener?: object
|
|
3077
|
+
): this;
|
|
3078
|
+
/**
|
|
3079
|
+
* Attaches event handler `fnFunction` to the {@link #event:collapse collapse} event of this `sap.me.TabContainer`.
|
|
3080
|
+
*
|
|
3081
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3082
|
+
* otherwise it will be bound to this `sap.me.TabContainer` itself.
|
|
3083
|
+
*
|
|
3084
|
+
* Indicates that the tab will collapse
|
|
3085
|
+
*
|
|
3086
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3087
|
+
*/
|
|
3088
|
+
attachCollapse(
|
|
3089
|
+
/**
|
|
3090
|
+
* The function to be called when the event occurs
|
|
3091
|
+
*/
|
|
3092
|
+
fnFunction: (p1: Event) => void,
|
|
3093
|
+
/**
|
|
3094
|
+
* Context object to call the event handler with. Defaults to this `sap.me.TabContainer` itself
|
|
3095
|
+
*/
|
|
3096
|
+
oListener?: object
|
|
3097
|
+
): this;
|
|
3098
|
+
/**
|
|
3099
|
+
* Attaches event handler `fnFunction` to the {@link #event:expand expand} event of this `sap.me.TabContainer`.
|
|
3100
|
+
*
|
|
3101
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3102
|
+
* otherwise it will be bound to this `sap.me.TabContainer` itself.
|
|
3103
|
+
*
|
|
3104
|
+
* Indicates that the tab will expand
|
|
3105
|
+
*
|
|
3106
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3107
|
+
*/
|
|
3108
|
+
attachExpand(
|
|
3109
|
+
/**
|
|
3110
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
3111
|
+
* object when firing the event
|
|
3112
|
+
*/
|
|
3113
|
+
oData: object,
|
|
3114
|
+
/**
|
|
3115
|
+
* The function to be called when the event occurs
|
|
3116
|
+
*/
|
|
3117
|
+
fnFunction: (p1: Event) => void,
|
|
3118
|
+
/**
|
|
3119
|
+
* Context object to call the event handler with. Defaults to this `sap.me.TabContainer` itself
|
|
3120
|
+
*/
|
|
3121
|
+
oListener?: object
|
|
3122
|
+
): this;
|
|
3123
|
+
/**
|
|
3124
|
+
* Attaches event handler `fnFunction` to the {@link #event:expand expand} event of this `sap.me.TabContainer`.
|
|
3125
|
+
*
|
|
3126
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3127
|
+
* otherwise it will be bound to this `sap.me.TabContainer` itself.
|
|
3128
|
+
*
|
|
3129
|
+
* Indicates that the tab will expand
|
|
3130
|
+
*
|
|
3131
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3132
|
+
*/
|
|
3133
|
+
attachExpand(
|
|
3134
|
+
/**
|
|
3135
|
+
* The function to be called when the event occurs
|
|
3136
|
+
*/
|
|
3137
|
+
fnFunction: (p1: Event) => void,
|
|
3138
|
+
/**
|
|
3139
|
+
* Context object to call the event handler with. Defaults to this `sap.me.TabContainer` itself
|
|
3140
|
+
*/
|
|
3141
|
+
oListener?: object
|
|
3142
|
+
): this;
|
|
3143
|
+
/**
|
|
3144
|
+
* Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.me.TabContainer`.
|
|
3145
|
+
*
|
|
3146
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3147
|
+
* otherwise it will be bound to this `sap.me.TabContainer` itself.
|
|
3148
|
+
*
|
|
3149
|
+
* Indicates that the selected tab has changed
|
|
3150
|
+
*
|
|
3151
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3152
|
+
*/
|
|
3153
|
+
attachSelect(
|
|
3154
|
+
/**
|
|
3155
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
3156
|
+
* object when firing the event
|
|
3157
|
+
*/
|
|
3158
|
+
oData: object,
|
|
3159
|
+
/**
|
|
3160
|
+
* The function to be called when the event occurs
|
|
3161
|
+
*/
|
|
3162
|
+
fnFunction: (p1: Event) => void,
|
|
3163
|
+
/**
|
|
3164
|
+
* Context object to call the event handler with. Defaults to this `sap.me.TabContainer` itself
|
|
3165
|
+
*/
|
|
3166
|
+
oListener?: object
|
|
3167
|
+
): this;
|
|
3168
|
+
/**
|
|
3169
|
+
* Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.me.TabContainer`.
|
|
3170
|
+
*
|
|
3171
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3172
|
+
* otherwise it will be bound to this `sap.me.TabContainer` itself.
|
|
3173
|
+
*
|
|
3174
|
+
* Indicates that the selected tab has changed
|
|
3175
|
+
*
|
|
3176
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3177
|
+
*/
|
|
3178
|
+
attachSelect(
|
|
3179
|
+
/**
|
|
3180
|
+
* The function to be called when the event occurs
|
|
3181
|
+
*/
|
|
3182
|
+
fnFunction: (p1: Event) => void,
|
|
3183
|
+
/**
|
|
3184
|
+
* Context object to call the event handler with. Defaults to this `sap.me.TabContainer` itself
|
|
3185
|
+
*/
|
|
3186
|
+
oListener?: object
|
|
3187
|
+
): this;
|
|
3188
|
+
/**
|
|
3189
|
+
* Destroys the contentAttachments in the aggregation {@link #getContentAttachments contentAttachments}.
|
|
3190
|
+
*
|
|
3191
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3192
|
+
*/
|
|
3193
|
+
destroyContentAttachments(): this;
|
|
3194
|
+
/**
|
|
3195
|
+
* Destroys the contentInfo in the aggregation {@link #getContentInfo contentInfo}.
|
|
3196
|
+
*
|
|
3197
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3198
|
+
*/
|
|
3199
|
+
destroyContentInfo(): this;
|
|
3200
|
+
/**
|
|
3201
|
+
* Destroys the contentNotes in the aggregation {@link #getContentNotes contentNotes}.
|
|
3202
|
+
*
|
|
3203
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3204
|
+
*/
|
|
3205
|
+
destroyContentNotes(): this;
|
|
3206
|
+
/**
|
|
3207
|
+
* Destroys the contentPeople in the aggregation {@link #getContentPeople contentPeople}.
|
|
3208
|
+
*
|
|
3209
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3210
|
+
*/
|
|
3211
|
+
destroyContentPeople(): this;
|
|
3212
|
+
/**
|
|
3213
|
+
* Detaches event handler `fnFunction` from the {@link #event:collapse collapse} event of this `sap.me.TabContainer`.
|
|
3214
|
+
*
|
|
3215
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
3216
|
+
*
|
|
3217
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3218
|
+
*/
|
|
3219
|
+
detachCollapse(
|
|
3220
|
+
/**
|
|
3221
|
+
* The function to be called, when the event occurs
|
|
3222
|
+
*/
|
|
3223
|
+
fnFunction: (p1: Event) => void,
|
|
3224
|
+
/**
|
|
3225
|
+
* Context object on which the given function had to be called
|
|
3226
|
+
*/
|
|
3227
|
+
oListener?: object
|
|
3228
|
+
): this;
|
|
3229
|
+
/**
|
|
3230
|
+
* Detaches event handler `fnFunction` from the {@link #event:expand expand} event of this `sap.me.TabContainer`.
|
|
3231
|
+
*
|
|
3232
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
3233
|
+
*
|
|
3234
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3235
|
+
*/
|
|
3236
|
+
detachExpand(
|
|
3237
|
+
/**
|
|
3238
|
+
* The function to be called, when the event occurs
|
|
3239
|
+
*/
|
|
3240
|
+
fnFunction: (p1: Event) => void,
|
|
3241
|
+
/**
|
|
3242
|
+
* Context object on which the given function had to be called
|
|
3243
|
+
*/
|
|
3244
|
+
oListener?: object
|
|
3245
|
+
): this;
|
|
3246
|
+
/**
|
|
3247
|
+
* Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.me.TabContainer`.
|
|
3248
|
+
*
|
|
3249
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
3250
|
+
*
|
|
3251
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3252
|
+
*/
|
|
3253
|
+
detachSelect(
|
|
3254
|
+
/**
|
|
3255
|
+
* The function to be called, when the event occurs
|
|
3256
|
+
*/
|
|
3257
|
+
fnFunction: (p1: Event) => void,
|
|
3258
|
+
/**
|
|
3259
|
+
* Context object on which the given function had to be called
|
|
3260
|
+
*/
|
|
3261
|
+
oListener?: object
|
|
3262
|
+
): this;
|
|
3263
|
+
/**
|
|
3264
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
3265
|
+
*
|
|
3266
|
+
* Fires event {@link #event:collapse collapse} to attached listeners.
|
|
3267
|
+
*
|
|
3268
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3269
|
+
*/
|
|
3270
|
+
fireCollapse(
|
|
3271
|
+
/**
|
|
3272
|
+
* Parameters to pass along with the event
|
|
3273
|
+
*/
|
|
3274
|
+
mParameters?: object
|
|
3275
|
+
): this;
|
|
3276
|
+
/**
|
|
3277
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
3278
|
+
*
|
|
3279
|
+
* Fires event {@link #event:expand expand} to attached listeners.
|
|
3280
|
+
*
|
|
3281
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3282
|
+
*/
|
|
3283
|
+
fireExpand(
|
|
3284
|
+
/**
|
|
3285
|
+
* Parameters to pass along with the event
|
|
3286
|
+
*/
|
|
3287
|
+
mParameters?: object
|
|
3288
|
+
): this;
|
|
3289
|
+
/**
|
|
3290
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
3291
|
+
*
|
|
3292
|
+
* Fires event {@link #event:select select} to attached listeners.
|
|
3293
|
+
*
|
|
3294
|
+
* Listeners may prevent the default action of this event by calling the `preventDefault` method on the
|
|
3295
|
+
* event object. The return value of this method indicates whether the default action should be executed.
|
|
3296
|
+
*
|
|
3297
|
+
* @returns Whether or not to prevent the default action
|
|
3298
|
+
*/
|
|
3299
|
+
fireSelect(
|
|
3300
|
+
/**
|
|
3301
|
+
* Parameters to pass along with the event
|
|
3302
|
+
*/
|
|
3303
|
+
mParameters?: object
|
|
3304
|
+
): boolean;
|
|
3305
|
+
/**
|
|
3306
|
+
* Gets current value of property {@link #getBadgeAttachments badgeAttachments}.
|
|
3307
|
+
*
|
|
3308
|
+
* The number to display in the badge for the attachments tab
|
|
3309
|
+
*
|
|
3310
|
+
* @returns Value of property `badgeAttachments`
|
|
3311
|
+
*/
|
|
3312
|
+
getBadgeAttachments(): int;
|
|
3313
|
+
/**
|
|
3314
|
+
* Gets current value of property {@link #getBadgeInfo badgeInfo}.
|
|
3315
|
+
*
|
|
3316
|
+
* The number to display in the badge for the info tab
|
|
3317
|
+
*
|
|
3318
|
+
* @returns Value of property `badgeInfo`
|
|
3319
|
+
*/
|
|
3320
|
+
getBadgeInfo(): int;
|
|
3321
|
+
/**
|
|
3322
|
+
* Gets current value of property {@link #getBadgeNotes badgeNotes}.
|
|
3323
|
+
*
|
|
3324
|
+
* The number to display in the badge for the notes tab
|
|
3325
|
+
*
|
|
3326
|
+
* @returns Value of property `badgeNotes`
|
|
3327
|
+
*/
|
|
3328
|
+
getBadgeNotes(): int;
|
|
3329
|
+
/**
|
|
3330
|
+
* Gets current value of property {@link #getBadgePeople badgePeople}.
|
|
3331
|
+
*
|
|
3332
|
+
* The number to display in the badge for the people tab
|
|
3333
|
+
*
|
|
3334
|
+
* @returns Value of property `badgePeople`
|
|
3335
|
+
*/
|
|
3336
|
+
getBadgePeople(): int;
|
|
3337
|
+
/**
|
|
3338
|
+
* Gets content of aggregation {@link #getContentAttachments contentAttachments}.
|
|
3339
|
+
*
|
|
3340
|
+
* The attachments tab
|
|
3341
|
+
*/
|
|
3342
|
+
getContentAttachments(): Control;
|
|
3343
|
+
/**
|
|
3344
|
+
* Gets content of aggregation {@link #getContentInfo contentInfo}.
|
|
3345
|
+
*
|
|
3346
|
+
* The info tab
|
|
3347
|
+
*/
|
|
3348
|
+
getContentInfo(): Control;
|
|
3349
|
+
/**
|
|
3350
|
+
* Gets content of aggregation {@link #getContentNotes contentNotes}.
|
|
3351
|
+
*
|
|
3352
|
+
* The notes tab
|
|
3353
|
+
*/
|
|
3354
|
+
getContentNotes(): Control;
|
|
3355
|
+
/**
|
|
3356
|
+
* Gets content of aggregation {@link #getContentPeople contentPeople}.
|
|
3357
|
+
*
|
|
3358
|
+
* The people tab
|
|
3359
|
+
*/
|
|
3360
|
+
getContentPeople(): Control;
|
|
3361
|
+
/**
|
|
3362
|
+
* Gets current value of property {@link #getExpandable expandable}.
|
|
3363
|
+
*
|
|
3364
|
+
* Indicates if the tab can be collapsed and expanded
|
|
3365
|
+
*
|
|
3366
|
+
* Default value is `true`.
|
|
3367
|
+
*
|
|
3368
|
+
* @returns Value of property `expandable`
|
|
3369
|
+
*/
|
|
3370
|
+
getExpandable(): boolean;
|
|
3371
|
+
/**
|
|
3372
|
+
* Gets current value of property {@link #getExpanded expanded}.
|
|
3373
|
+
*
|
|
3374
|
+
* Indicates if the actual tab is expanded or not
|
|
3375
|
+
*
|
|
3376
|
+
* Default value is `true`.
|
|
3377
|
+
*
|
|
3378
|
+
* @returns Value of property `expanded`
|
|
3379
|
+
*/
|
|
3380
|
+
getExpanded(): boolean;
|
|
3381
|
+
/**
|
|
3382
|
+
* Gets current value of property {@link #getSelectedTab selectedTab}.
|
|
3383
|
+
*
|
|
3384
|
+
* Return the index of the selected tab
|
|
3385
|
+
*
|
|
3386
|
+
* @returns Value of property `selectedTab`
|
|
3387
|
+
*/
|
|
3388
|
+
getSelectedTab(): int;
|
|
3389
|
+
/**
|
|
3390
|
+
* Gets current value of property {@link #getVisible visible}.
|
|
3391
|
+
*
|
|
3392
|
+
* setter for visible property
|
|
3393
|
+
*
|
|
3394
|
+
* Default value is `true`.
|
|
3395
|
+
*
|
|
3396
|
+
* @returns Value of property `visible`
|
|
3397
|
+
*/
|
|
3398
|
+
getVisible(): boolean;
|
|
3399
|
+
/**
|
|
3400
|
+
* Sets a new value for property {@link #getBadgeAttachments badgeAttachments}.
|
|
3401
|
+
*
|
|
3402
|
+
* The number to display in the badge for the attachments tab
|
|
3403
|
+
*
|
|
3404
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3405
|
+
*
|
|
3406
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3407
|
+
*/
|
|
3408
|
+
setBadgeAttachments(
|
|
3409
|
+
/**
|
|
3410
|
+
* New value for property `badgeAttachments`
|
|
3411
|
+
*/
|
|
3412
|
+
iBadgeAttachments?: int
|
|
3413
|
+
): this;
|
|
3414
|
+
/**
|
|
3415
|
+
* Sets a new value for property {@link #getBadgeInfo badgeInfo}.
|
|
3416
|
+
*
|
|
3417
|
+
* The number to display in the badge for the info tab
|
|
3418
|
+
*
|
|
3419
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3420
|
+
*
|
|
3421
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3422
|
+
*/
|
|
3423
|
+
setBadgeInfo(
|
|
3424
|
+
/**
|
|
3425
|
+
* New value for property `badgeInfo`
|
|
3426
|
+
*/
|
|
3427
|
+
iBadgeInfo?: int
|
|
3428
|
+
): this;
|
|
3429
|
+
/**
|
|
3430
|
+
* Sets a new value for property {@link #getBadgeNotes badgeNotes}.
|
|
3431
|
+
*
|
|
3432
|
+
* The number to display in the badge for the notes tab
|
|
3433
|
+
*
|
|
3434
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3435
|
+
*
|
|
3436
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3437
|
+
*/
|
|
3438
|
+
setBadgeNotes(
|
|
3439
|
+
/**
|
|
3440
|
+
* New value for property `badgeNotes`
|
|
3441
|
+
*/
|
|
3442
|
+
iBadgeNotes?: int
|
|
3443
|
+
): this;
|
|
3444
|
+
/**
|
|
3445
|
+
* Sets a new value for property {@link #getBadgePeople badgePeople}.
|
|
3446
|
+
*
|
|
3447
|
+
* The number to display in the badge for the people tab
|
|
3448
|
+
*
|
|
3449
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3450
|
+
*
|
|
3451
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3452
|
+
*/
|
|
3453
|
+
setBadgePeople(
|
|
3454
|
+
/**
|
|
3455
|
+
* New value for property `badgePeople`
|
|
3456
|
+
*/
|
|
3457
|
+
iBadgePeople?: int
|
|
3458
|
+
): this;
|
|
3459
|
+
/**
|
|
3460
|
+
* Sets the aggregated {@link #getContentAttachments contentAttachments}.
|
|
3461
|
+
*
|
|
3462
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3463
|
+
*/
|
|
3464
|
+
setContentAttachments(
|
|
3465
|
+
/**
|
|
3466
|
+
* The contentAttachments to set
|
|
3467
|
+
*/
|
|
3468
|
+
oContentAttachments: Control
|
|
3469
|
+
): this;
|
|
3470
|
+
/**
|
|
3471
|
+
* Sets the aggregated {@link #getContentInfo contentInfo}.
|
|
3472
|
+
*
|
|
3473
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3474
|
+
*/
|
|
3475
|
+
setContentInfo(
|
|
3476
|
+
/**
|
|
3477
|
+
* The contentInfo to set
|
|
3478
|
+
*/
|
|
3479
|
+
oContentInfo: Control
|
|
3480
|
+
): this;
|
|
3481
|
+
/**
|
|
3482
|
+
* Sets the aggregated {@link #getContentNotes contentNotes}.
|
|
3483
|
+
*
|
|
3484
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3485
|
+
*/
|
|
3486
|
+
setContentNotes(
|
|
3487
|
+
/**
|
|
3488
|
+
* The contentNotes to set
|
|
3489
|
+
*/
|
|
3490
|
+
oContentNotes: Control
|
|
3491
|
+
): this;
|
|
3492
|
+
/**
|
|
3493
|
+
* Sets the aggregated {@link #getContentPeople contentPeople}.
|
|
3494
|
+
*
|
|
3495
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3496
|
+
*/
|
|
3497
|
+
setContentPeople(
|
|
3498
|
+
/**
|
|
3499
|
+
* The contentPeople to set
|
|
3500
|
+
*/
|
|
3501
|
+
oContentPeople: Control
|
|
3502
|
+
): this;
|
|
3503
|
+
/**
|
|
3504
|
+
* Sets a new value for property {@link #getExpandable expandable}.
|
|
3505
|
+
*
|
|
3506
|
+
* Indicates if the tab can be collapsed and expanded
|
|
3507
|
+
*
|
|
3508
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3509
|
+
*
|
|
3510
|
+
* Default value is `true`.
|
|
3511
|
+
*
|
|
3512
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3513
|
+
*/
|
|
3514
|
+
setExpandable(
|
|
3515
|
+
/**
|
|
3516
|
+
* New value for property `expandable`
|
|
3517
|
+
*/
|
|
3518
|
+
bExpandable?: boolean
|
|
3519
|
+
): this;
|
|
3520
|
+
/**
|
|
3521
|
+
* Sets a new value for property {@link #getExpanded expanded}.
|
|
3522
|
+
*
|
|
3523
|
+
* Indicates if the actual tab is expanded or not
|
|
3524
|
+
*
|
|
3525
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3526
|
+
*
|
|
3527
|
+
* Default value is `true`.
|
|
3528
|
+
*
|
|
3529
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3530
|
+
*/
|
|
3531
|
+
setExpanded(
|
|
3532
|
+
/**
|
|
3533
|
+
* New value for property `expanded`
|
|
3534
|
+
*/
|
|
3535
|
+
bExpanded?: boolean
|
|
3536
|
+
): this;
|
|
3537
|
+
/**
|
|
3538
|
+
* Sets a new value for property {@link #getSelectedTab selectedTab}.
|
|
3539
|
+
*
|
|
3540
|
+
* Return the index of the selected tab
|
|
3541
|
+
*
|
|
3542
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3543
|
+
*
|
|
3544
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3545
|
+
*/
|
|
3546
|
+
setSelectedTab(
|
|
3547
|
+
/**
|
|
3548
|
+
* New value for property `selectedTab`
|
|
3549
|
+
*/
|
|
3550
|
+
iSelectedTab?: int
|
|
3551
|
+
): this;
|
|
3552
|
+
/**
|
|
3553
|
+
* Sets a new value for property {@link #getVisible visible}.
|
|
3554
|
+
*
|
|
3555
|
+
* setter for visible property
|
|
3556
|
+
*
|
|
3557
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3558
|
+
*
|
|
3559
|
+
* Default value is `true`.
|
|
3560
|
+
*
|
|
3561
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3562
|
+
*/
|
|
3563
|
+
setVisible(
|
|
3564
|
+
/**
|
|
3565
|
+
* New value for property `visible`
|
|
3566
|
+
*/
|
|
3567
|
+
bVisible?: boolean
|
|
3568
|
+
): this;
|
|
3569
|
+
}
|
|
3570
|
+
|
|
3571
|
+
export interface $TabContainerSettings extends $ControlSettings {
|
|
3572
|
+
/**
|
|
3573
|
+
* Return the index of the selected tab
|
|
3574
|
+
*/
|
|
3575
|
+
selectedTab?: int | PropertyBindingInfo | `{${string}}`;
|
|
3576
|
+
|
|
3577
|
+
/**
|
|
3578
|
+
* The number to display in the badge for the info tab
|
|
3579
|
+
*/
|
|
3580
|
+
badgeInfo?: int | PropertyBindingInfo | `{${string}}`;
|
|
3581
|
+
|
|
3582
|
+
/**
|
|
3583
|
+
* The number to display in the badge for the notes tab
|
|
3584
|
+
*/
|
|
3585
|
+
badgeNotes?: int | PropertyBindingInfo | `{${string}}`;
|
|
3586
|
+
|
|
3587
|
+
/**
|
|
3588
|
+
* The number to display in the badge for the attachments tab
|
|
3589
|
+
*/
|
|
3590
|
+
badgeAttachments?: int | PropertyBindingInfo | `{${string}}`;
|
|
3591
|
+
|
|
3592
|
+
/**
|
|
3593
|
+
* The number to display in the badge for the people tab
|
|
3594
|
+
*/
|
|
3595
|
+
badgePeople?: int | PropertyBindingInfo | `{${string}}`;
|
|
3596
|
+
|
|
3597
|
+
/**
|
|
3598
|
+
* Indicates if the tab can be collapsed and expanded
|
|
3599
|
+
*/
|
|
3600
|
+
expandable?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
3601
|
+
|
|
3602
|
+
/**
|
|
3603
|
+
* Indicates if the actual tab is expanded or not
|
|
3604
|
+
*/
|
|
3605
|
+
expanded?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
3606
|
+
|
|
3607
|
+
/**
|
|
3608
|
+
* setter for visible property
|
|
3609
|
+
*/
|
|
3610
|
+
visible?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
3611
|
+
|
|
3612
|
+
/**
|
|
3613
|
+
* The info tab
|
|
3614
|
+
*/
|
|
3615
|
+
contentInfo?: Control;
|
|
3616
|
+
|
|
3617
|
+
/**
|
|
3618
|
+
* The attachments tab
|
|
3619
|
+
*/
|
|
3620
|
+
contentAttachments?: Control;
|
|
3621
|
+
|
|
3622
|
+
/**
|
|
3623
|
+
* The notes tab
|
|
3624
|
+
*/
|
|
3625
|
+
contentNotes?: Control;
|
|
3626
|
+
|
|
3627
|
+
/**
|
|
3628
|
+
* The people tab
|
|
3629
|
+
*/
|
|
3630
|
+
contentPeople?: Control;
|
|
3631
|
+
|
|
3632
|
+
/**
|
|
3633
|
+
* Indicates that the selected tab has changed
|
|
3634
|
+
*/
|
|
3635
|
+
select?: (oEvent: Event) => void;
|
|
3636
|
+
|
|
3637
|
+
/**
|
|
3638
|
+
* Indicates that the tab will expand
|
|
3639
|
+
*/
|
|
3640
|
+
expand?: (oEvent: Event) => void;
|
|
3641
|
+
|
|
3642
|
+
/**
|
|
3643
|
+
* Indicates that the tab will collapse
|
|
3644
|
+
*/
|
|
3645
|
+
collapse?: (oEvent: Event) => void;
|
|
3646
|
+
}
|
|
3647
|
+
}
|
|
3648
|
+
|
|
3649
|
+
declare namespace sap {
|
|
3650
|
+
interface IUI5DefineDependencyNames {
|
|
3651
|
+
"sap/me/Calendar": undefined;
|
|
3652
|
+
|
|
3653
|
+
"sap/me/CalendarLegend": undefined;
|
|
3654
|
+
|
|
3655
|
+
"sap/me/library": undefined;
|
|
3656
|
+
|
|
3657
|
+
"sap/me/OverlapCalendar": undefined;
|
|
3658
|
+
|
|
3659
|
+
"sap/me/OverlapCalendarEvent": undefined;
|
|
3660
|
+
|
|
3661
|
+
"sap/me/ProgressIndicator": undefined;
|
|
3662
|
+
|
|
3663
|
+
"sap/me/TabContainer": undefined;
|
|
3664
|
+
}
|
|
3665
|
+
}
|