@sapui5/ts-types-esm 1.139.0 → 1.141.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/package.json +1 -1
- package/types/sap.apf.d.ts +1 -1
- package/types/sap.ca.ui.d.ts +1 -1
- package/types/sap.chart.d.ts +1 -1
- package/types/sap.collaboration.d.ts +1 -1
- package/types/sap.cux.home.d.ts +0 -1623
- package/types/sap.esh.search.ui.d.ts +384 -1
- package/types/sap.f.d.ts +102 -13
- package/types/sap.fe.ariba.d.ts +1 -1
- package/types/sap.fe.base.d.ts +1 -5
- package/types/sap.fe.controls.d.ts +1 -1
- package/types/sap.fe.core.d.ts +98 -8
- package/types/sap.fe.ina.d.ts +1 -1
- package/types/sap.fe.macros.d.ts +369 -51
- package/types/sap.fe.navigation.d.ts +13 -15
- package/types/sap.fe.placeholder.d.ts +1 -1
- package/types/sap.fe.plugins.managecache.d.ts +1 -1
- package/types/sap.fe.templates.d.ts +1 -1
- package/types/sap.fe.test.d.ts +1 -1
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +47 -11
- package/types/sap.insights.d.ts +130 -2
- package/types/sap.m.d.ts +722 -282
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +1 -1
- package/types/sap.ovp.d.ts +1 -1
- package/types/sap.rules.ui.d.ts +1 -1
- package/types/sap.sac.df.d.ts +118 -5
- package/types/sap.suite.ui.commons.d.ts +1 -1
- package/types/sap.suite.ui.generic.template.d.ts +41 -5
- package/types/sap.suite.ui.microchart.d.ts +1 -1
- package/types/sap.tnt.d.ts +5 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.comp.d.ts +16 -1
- package/types/sap.ui.core.d.ts +531 -163
- package/types/sap.ui.dt.d.ts +202 -1
- package/types/sap.ui.export.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +8 -13
- package/types/sap.ui.generic.app.d.ts +1 -1
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +13 -13
- package/types/sap.ui.layout.d.ts +63 -47
- package/types/sap.ui.mdc.d.ts +77 -25
- package/types/sap.ui.richtexteditor.d.ts +309 -9
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +1 -1
- package/types/sap.ui.table.d.ts +585 -4
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +55 -3
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.vbm.d.ts +1 -1
- package/types/sap.ui.vk.d.ts +438 -6
- package/types/sap.ui.vtm.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +1 -1
- package/types/sap.ui.webc.main.d.ts +1 -1
- package/types/sap.uiext.inbox.d.ts +1 -1
- package/types/sap.ushell.d.ts +41 -8
- package/types/sap.ushell_abap.d.ts +7 -1
- package/types/sap.uxap.d.ts +1 -1
- package/types/sap.viz.d.ts +1 -1
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +1 -1
- package/types/sap.zen.crosstab.d.ts +1 -1
- package/types/sap.zen.dsh.d.ts +1 -1
package/types/sap.ui.mdc.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.141.0
|
|
2
2
|
|
|
3
3
|
declare module "sap/ui/mdc/AggregationBaseDelegate" {
|
|
4
4
|
import BaseDelegate from "sap/ui/mdc/BaseDelegate";
|
|
@@ -160,7 +160,7 @@ declare module "sap/ui/mdc/ChartDelegate" {
|
|
|
160
160
|
|
|
161
161
|
import { AggregationBindingInfo } from "sap/ui/base/ManagedObject";
|
|
162
162
|
|
|
163
|
-
import
|
|
163
|
+
import { FilterDelegateObject } from "sap/ui/mdc/library";
|
|
164
164
|
|
|
165
165
|
import Filter from "sap/ui/model/Filter";
|
|
166
166
|
|
|
@@ -387,9 +387,7 @@ declare module "sap/ui/mdc/ChartDelegate" {
|
|
|
387
387
|
*
|
|
388
388
|
* @returns Object for the chart filter personalization
|
|
389
389
|
*/
|
|
390
|
-
getFilterDelegate():
|
|
391
|
-
addItem: (p1: Chart, p2: string) => Promise<FilterField>;
|
|
392
|
-
};
|
|
390
|
+
getFilterDelegate(): FilterDelegateObject;
|
|
393
391
|
/**
|
|
394
392
|
* Gets the filters that are applied when updating the chart's binding based on the filter conditions of
|
|
395
393
|
* the chart itself and its associated {@link sap.ui.mdc.IFilterSource IFilterSource}.
|
|
@@ -1903,6 +1901,9 @@ declare module "sap/ui/mdc/odata/v4/TableDelegate" {
|
|
|
1903
1901
|
* The `p13nMode` `Group` is not supported if the table type is {@link sap.ui.mdc.table.TreeTableType TreeTable}.
|
|
1904
1902
|
* This cannot be changed in your delegate implementation.
|
|
1905
1903
|
*
|
|
1904
|
+
* All binding-related limitations regarding selection also apply in the context of this delegate. For details,
|
|
1905
|
+
* see {@link sap.ui.model.odata.v4.Context#setSelected} and {@link sap.ui.model.odata.v4.ODataModel#bindList}.
|
|
1906
|
+
*
|
|
1906
1907
|
* @since 1.85
|
|
1907
1908
|
*/
|
|
1908
1909
|
interface TableDelegate extends TableDelegate1 {
|
|
@@ -2102,7 +2103,7 @@ declare module "sap/ui/mdc/TableDelegate" {
|
|
|
2102
2103
|
|
|
2103
2104
|
import Context from "sap/ui/model/Context";
|
|
2104
2105
|
|
|
2105
|
-
import
|
|
2106
|
+
import { FilterDelegateObject } from "sap/ui/mdc/library";
|
|
2106
2107
|
|
|
2107
2108
|
import Filter from "sap/ui/model/Filter";
|
|
2108
2109
|
|
|
@@ -2248,17 +2249,11 @@ declare module "sap/ui/mdc/TableDelegate" {
|
|
|
2248
2249
|
* Returns the filter delegate of the table that provides basic filter functionality, such as adding filter
|
|
2249
2250
|
* fields.
|
|
2250
2251
|
*
|
|
2251
|
-
* **Note:** The functionality provided in this delegate acts as a subset of a `FilterBarDelegate` to enable
|
|
2252
|
-
* the table for inbuilt filtering.
|
|
2253
|
-
*
|
|
2254
|
-
*
|
|
2255
2252
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
2256
2253
|
*
|
|
2257
2254
|
* @returns Object for the tables filter personalization
|
|
2258
2255
|
*/
|
|
2259
|
-
getFilterDelegate():
|
|
2260
|
-
addItem: (p1: Table, p2: string) => Promise<FilterField>;
|
|
2261
|
-
};
|
|
2256
|
+
getFilterDelegate(): FilterDelegateObject;
|
|
2262
2257
|
/**
|
|
2263
2258
|
* Returns filters to be applied when updating the table's binding based on the filter conditions of the
|
|
2264
2259
|
* table itself and its associated {@link sap.ui.mdc.IFilterSource IFilterSource}.
|
|
@@ -3400,13 +3395,19 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
|
|
|
3400
3395
|
}
|
|
3401
3396
|
|
|
3402
3397
|
declare module "sap/ui/mdc/library" {
|
|
3398
|
+
import Control from "sap/ui/mdc/Control";
|
|
3399
|
+
|
|
3400
|
+
import FilterField from "sap/ui/mdc/FilterField";
|
|
3401
|
+
|
|
3402
|
+
import FilterBarValidationStatus from "sap/ui/mdc/enums/FilterBarValidationStatus";
|
|
3403
|
+
|
|
3403
3404
|
import { ConditionObject } from "sap/ui/mdc/condition/Condition";
|
|
3404
3405
|
|
|
3405
3406
|
import Type from "sap/ui/model/Type";
|
|
3406
3407
|
|
|
3407
3408
|
import BaseType from "sap/ui/mdc/enums/BaseType";
|
|
3408
3409
|
|
|
3409
|
-
import
|
|
3410
|
+
import Control1 from "sap/ui/core/Control";
|
|
3410
3411
|
|
|
3411
3412
|
import {
|
|
3412
3413
|
ItemForValueConfiguration,
|
|
@@ -3417,6 +3418,32 @@ declare module "sap/ui/mdc/library" {
|
|
|
3417
3418
|
|
|
3418
3419
|
import ParseException from "sap/ui/model/ParseException";
|
|
3419
3420
|
|
|
3421
|
+
/**
|
|
3422
|
+
* Acts a subset of the `FilterBarDelegate` that can be used in {@link module:sap/ui/mdc/TableDelegate.getFilterDelegate TableDelegate.getFilterDelegate }
|
|
3423
|
+
* or {@link module:sap/ui/mdc/ChartDelegate.getFilterDelegate Chart.getFilterDelegate} to enable inbuilt
|
|
3424
|
+
* filtering.
|
|
3425
|
+
*
|
|
3426
|
+
* It provides basic filter functionality, including
|
|
3427
|
+
* - Adding filter fields
|
|
3428
|
+
* - Adding conditions
|
|
3429
|
+
* - Removing conditions
|
|
3430
|
+
* - Determining the validation state of filters
|
|
3431
|
+
*/
|
|
3432
|
+
export type FilterDelegateObject = {
|
|
3433
|
+
addItem?: (p1: Control, p2: string) => Promise<FilterField>;
|
|
3434
|
+
|
|
3435
|
+
addCondition?: (p1: Control, p2: string) => Promise<any>;
|
|
3436
|
+
|
|
3437
|
+
removeCondition?: (p1: Control, p2: string) => Promise<any>;
|
|
3438
|
+
|
|
3439
|
+
determineValidationState?: (
|
|
3440
|
+
p1: Control,
|
|
3441
|
+
p2: string
|
|
3442
|
+
) => Promise<
|
|
3443
|
+
FilterBarValidationStatus | keyof typeof FilterBarValidationStatus
|
|
3444
|
+
>;
|
|
3445
|
+
};
|
|
3446
|
+
|
|
3420
3447
|
/**
|
|
3421
3448
|
* Interface for controls or entities which can serve as filters in the `sap.ui.mdc.Table` & `sap.ui.mdc.Chart`.
|
|
3422
3449
|
*
|
|
@@ -3703,7 +3730,7 @@ declare module "sap/ui/mdc/library" {
|
|
|
3703
3730
|
*
|
|
3704
3731
|
* @returns Promise resolving in displayed content
|
|
3705
3732
|
*/
|
|
3706
|
-
getContent(): Promise<
|
|
3733
|
+
getContent(): Promise<Control1>;
|
|
3707
3734
|
/**
|
|
3708
3735
|
* Returns a title for the given Content
|
|
3709
3736
|
*
|
|
@@ -3852,7 +3879,7 @@ declare module "sap/ui/mdc/library" {
|
|
|
3852
3879
|
*
|
|
3853
3880
|
* @returns Promise resolving in displayed content
|
|
3854
3881
|
*/
|
|
3855
|
-
getContent(): Promise<
|
|
3882
|
+
getContent(): Promise<Control1>;
|
|
3856
3883
|
/**
|
|
3857
3884
|
* Determines the item (key and description) for a given value.
|
|
3858
3885
|
*
|
|
@@ -3944,7 +3971,10 @@ declare module "sap/ui/mdc/library" {
|
|
|
3944
3971
|
declare module "sap/ui/mdc/actiontoolbar/ActionToolbarAction" {
|
|
3945
3972
|
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
3946
3973
|
|
|
3947
|
-
import {
|
|
3974
|
+
import {
|
|
3975
|
+
IOverflowToolbarContent,
|
|
3976
|
+
IToolbarInteractiveControl,
|
|
3977
|
+
} from "sap/m/library";
|
|
3948
3978
|
|
|
3949
3979
|
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
3950
3980
|
|
|
@@ -3960,9 +3990,10 @@ declare module "sap/ui/mdc/actiontoolbar/ActionToolbarAction" {
|
|
|
3960
3990
|
*/
|
|
3961
3991
|
export default class ActionToolbarAction
|
|
3962
3992
|
extends Control
|
|
3963
|
-
implements IOverflowToolbarContent
|
|
3993
|
+
implements IOverflowToolbarContent, IToolbarInteractiveControl
|
|
3964
3994
|
{
|
|
3965
3995
|
__implements__sap_m_IOverflowToolbarContent: boolean;
|
|
3996
|
+
__implements__sap_m_IToolbarInteractiveControl: boolean;
|
|
3966
3997
|
/**
|
|
3967
3998
|
* Constructor for a new ActionToolbarAction.
|
|
3968
3999
|
*
|
|
@@ -6695,13 +6726,13 @@ declare module "sap/ui/mdc/condition/Operator" {
|
|
|
6695
6726
|
* 5 days". (In this case `#tokenText#` is used in `tokenFormat`, `tokenTest`, or `tokenParse`.) For operators
|
|
6696
6727
|
* just showing the value and a operator symbol, no token text is needed.
|
|
6697
6728
|
* If the token text is not given, the `longText` is used. If `tokenTextForTypes` is provided for a special
|
|
6698
|
-
* type,
|
|
6729
|
+
* type, it will be used for that.
|
|
6699
6730
|
*/
|
|
6700
6731
|
tokenText?: string;
|
|
6701
6732
|
/**
|
|
6702
|
-
* Object holding
|
|
6703
|
-
* This text is shown in a single-value field as
|
|
6704
|
-
* This is needed if the text depends on the
|
|
6733
|
+
* Object holding string representation of the operator as a token text for single basic types.
|
|
6734
|
+
* This text is shown as text in a single-value field or as token in a multi-value field.
|
|
6735
|
+
* This is needed if the text depends on the data type used. For example, the "equal" operator should be
|
|
6705
6736
|
* named "Not Specified (empty)" if a date or time type is used.
|
|
6706
6737
|
*/
|
|
6707
6738
|
tokenTextForTypes?: object;
|
|
@@ -6789,7 +6820,7 @@ declare module "sap/ui/mdc/condition/Operator" {
|
|
|
6789
6820
|
* to 3, 4....
|
|
6790
6821
|
* group: {id : 10, text: "new group at the end"} - adds a new group with id 10 and text "new group as
|
|
6791
6822
|
* the end" to the end of all groups
|
|
6792
|
-
* **Note:** The ids 900-999 are reserved for internal mdc usage, please use
|
|
6823
|
+
* **Note:** The ids 900-999 are reserved for internal mdc usage, please use only IDs outside of this range.
|
|
6793
6824
|
*/
|
|
6794
6825
|
id: string;
|
|
6795
6826
|
/**
|
|
@@ -6798,8 +6829,8 @@ declare module "sap/ui/mdc/condition/Operator" {
|
|
|
6798
6829
|
text?: string;
|
|
6799
6830
|
};
|
|
6800
6831
|
/**
|
|
6801
|
-
* Additional group settings for the operator depending on the type. For every type a group object can
|
|
6802
|
-
* defined.
|
|
6832
|
+
* Additional group settings for the operator depending on the type. For every type, a group object can
|
|
6833
|
+
* be defined.
|
|
6803
6834
|
*/
|
|
6804
6835
|
groupsForTypes?: object;
|
|
6805
6836
|
/**
|
|
@@ -24348,6 +24379,8 @@ declare module "sap/ui/mdc/valuehelp/content/FixedList" {
|
|
|
24348
24379
|
*
|
|
24349
24380
|
* By default, if not set, the list opens if the user clicks into the connected field.
|
|
24350
24381
|
*
|
|
24382
|
+
* **Note: ** if `restrictedToFixedValues` is set, filtering should be disabled.
|
|
24383
|
+
*
|
|
24351
24384
|
* Default value is `true`.
|
|
24352
24385
|
*
|
|
24353
24386
|
*
|
|
@@ -24383,6 +24416,8 @@ declare module "sap/ui/mdc/valuehelp/content/FixedList" {
|
|
|
24383
24416
|
* If set, the connected field must not allow other values than the items of the `FixedList`. Free text
|
|
24384
24417
|
* must be avoided.
|
|
24385
24418
|
*
|
|
24419
|
+
* By default, if set, the list opens if the user clicks into the connected field.
|
|
24420
|
+
*
|
|
24386
24421
|
* Default value is `false`.
|
|
24387
24422
|
*
|
|
24388
24423
|
* @since 1.138
|
|
@@ -24474,6 +24509,8 @@ declare module "sap/ui/mdc/valuehelp/content/FixedList" {
|
|
|
24474
24509
|
*
|
|
24475
24510
|
* By default, if not set, the list opens if the user clicks into the connected field.
|
|
24476
24511
|
*
|
|
24512
|
+
* **Note: ** if `restrictedToFixedValues` is set, filtering should be disabled.
|
|
24513
|
+
*
|
|
24477
24514
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
24478
24515
|
*
|
|
24479
24516
|
* Default value is `true`.
|
|
@@ -24511,6 +24548,8 @@ declare module "sap/ui/mdc/valuehelp/content/FixedList" {
|
|
|
24511
24548
|
* If set, the connected field must not allow other values than the items of the `FixedList`. Free text
|
|
24512
24549
|
* must be avoided.
|
|
24513
24550
|
*
|
|
24551
|
+
* By default, if set, the list opens if the user clicks into the connected field.
|
|
24552
|
+
*
|
|
24514
24553
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
24515
24554
|
*
|
|
24516
24555
|
* Default value is `false`.
|
|
@@ -24543,6 +24582,8 @@ declare module "sap/ui/mdc/valuehelp/content/FixedList" {
|
|
|
24543
24582
|
* case this property must be set to `false`.
|
|
24544
24583
|
*
|
|
24545
24584
|
* By default, if not set, the list opens if the user clicks into the connected field.
|
|
24585
|
+
*
|
|
24586
|
+
* **Note: ** if `restrictedToFixedValues` is set, filtering should be disabled.
|
|
24546
24587
|
*/
|
|
24547
24588
|
filterList?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
24548
24589
|
|
|
@@ -24559,6 +24600,8 @@ declare module "sap/ui/mdc/valuehelp/content/FixedList" {
|
|
|
24559
24600
|
* If set, the connected field must not allow other values than the items of the `FixedList`. Free text
|
|
24560
24601
|
* must be avoided.
|
|
24561
24602
|
*
|
|
24603
|
+
* By default, if set, the list opens if the user clicks into the connected field.
|
|
24604
|
+
*
|
|
24562
24605
|
* @since 1.138
|
|
24563
24606
|
*/
|
|
24564
24607
|
restrictedToFixedValues?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
@@ -24850,6 +24893,15 @@ declare module "sap/ui/mdc/valuehelp/Dialog" {
|
|
|
24850
24893
|
* @returns Value of property `groupConfig`
|
|
24851
24894
|
*/
|
|
24852
24895
|
getGroupConfig(): object;
|
|
24896
|
+
/**
|
|
24897
|
+
* Gets whether quickselect (confirms values on selection) is active on the dialog.
|
|
24898
|
+
*
|
|
24899
|
+
* @since 1.140
|
|
24900
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
24901
|
+
*
|
|
24902
|
+
* @returns true if quickselect is active
|
|
24903
|
+
*/
|
|
24904
|
+
isQuickSelectActive(): boolean;
|
|
24853
24905
|
/**
|
|
24854
24906
|
* Sets a new value for property {@link #getGroupConfig groupConfig}.
|
|
24855
24907
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.141.0
|
|
2
2
|
|
|
3
3
|
declare module "sap/ui/richtexteditor/library" {
|
|
4
4
|
/**
|
|
@@ -12,10 +12,6 @@ declare module "sap/ui/richtexteditor/library" {
|
|
|
12
12
|
* Uses latest recommended TinyMCE version Current one is TinyMCE 7
|
|
13
13
|
*/
|
|
14
14
|
TinyMCE = "TinyMCE",
|
|
15
|
-
/**
|
|
16
|
-
* Uses TinyMCE version 6 as editor
|
|
17
|
-
*/
|
|
18
|
-
TinyMCE6 = "TinyMCE6",
|
|
19
15
|
/**
|
|
20
16
|
* Uses TinyMCE version 7 as editor
|
|
21
17
|
*/
|
|
@@ -36,6 +32,8 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
|
|
|
36
32
|
|
|
37
33
|
import { ID, CSSSize, TextDirection } from "sap/ui/core/library";
|
|
38
34
|
|
|
35
|
+
import RichTextEditorFontFamily from "sap/ui/richtexteditor/RichTextEditorFontFamily";
|
|
36
|
+
|
|
39
37
|
import Event from "sap/ui/base/Event";
|
|
40
38
|
|
|
41
39
|
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
@@ -263,6 +261,19 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
|
|
|
263
261
|
*/
|
|
264
262
|
oCustomButton: Control
|
|
265
263
|
): this;
|
|
264
|
+
/**
|
|
265
|
+
* Adds some customFont to the aggregation {@link #getCustomFonts customFonts}.
|
|
266
|
+
*
|
|
267
|
+
* @since 1.141
|
|
268
|
+
*
|
|
269
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
270
|
+
*/
|
|
271
|
+
addCustomFont(
|
|
272
|
+
/**
|
|
273
|
+
* The customFont to add; if empty, nothing is inserted
|
|
274
|
+
*/
|
|
275
|
+
oCustomFont: RichTextEditorFontFamily
|
|
276
|
+
): this;
|
|
266
277
|
/**
|
|
267
278
|
* Allows to add a plugin (that must already be installed on the server) to the RichTextEditor.
|
|
268
279
|
*
|
|
@@ -497,6 +508,14 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
|
|
|
497
508
|
* @returns Reference to `this` in order to allow method chaining
|
|
498
509
|
*/
|
|
499
510
|
destroyCustomButtons(): this;
|
|
511
|
+
/**
|
|
512
|
+
* Destroys all the customFonts in the aggregation {@link #getCustomFonts customFonts}.
|
|
513
|
+
*
|
|
514
|
+
* @since 1.141
|
|
515
|
+
*
|
|
516
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
517
|
+
*/
|
|
518
|
+
destroyCustomFonts(): this;
|
|
500
519
|
/**
|
|
501
520
|
* Destroys the footer in the aggregation {@link #getFooter footer}.
|
|
502
521
|
*
|
|
@@ -659,12 +678,21 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
|
|
|
659
678
|
* Gets content of aggregation {@link #getCustomButtons customButtons}.
|
|
660
679
|
*
|
|
661
680
|
* Custom buttons are meant to extend the `RichTextEditor`'s custom toolbar. Though type is set to sap.ui.Control,
|
|
662
|
-
* only sap.m.Button is allowed. **Note:** customButtons are available only when the customToolbar is
|
|
663
|
-
* and all the requirements are fulfilled.
|
|
681
|
+
* only sap.m.Button is allowed. **Note:** customButtons are available only when the `customToolbar` is
|
|
682
|
+
* enabled and all the requirements are fulfilled.
|
|
664
683
|
*
|
|
665
684
|
* @since 1.48
|
|
666
685
|
*/
|
|
667
686
|
getCustomButtons(): Control[];
|
|
687
|
+
/**
|
|
688
|
+
* Gets content of aggregation {@link #getCustomFonts customFonts}.
|
|
689
|
+
*
|
|
690
|
+
* Custom font families that can be used in the `RichTextEditor`. **Note:** Custom fonts are available only
|
|
691
|
+
* when the `customToolbar` is enabled.
|
|
692
|
+
*
|
|
693
|
+
* @since 1.141
|
|
694
|
+
*/
|
|
695
|
+
getCustomFonts(): RichTextEditorFontFamily[];
|
|
668
696
|
/**
|
|
669
697
|
* Gets current value of property {@link #getCustomToolbar customToolbar}.
|
|
670
698
|
*
|
|
@@ -996,6 +1024,20 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
|
|
|
996
1024
|
*/
|
|
997
1025
|
oCustomButton: Control
|
|
998
1026
|
): int;
|
|
1027
|
+
/**
|
|
1028
|
+
* Checks for the provided `sap.ui.richtexteditor.RichTextEditorFontFamily` in the aggregation {@link #getCustomFonts customFonts}.
|
|
1029
|
+
* and returns its index if found or -1 otherwise.
|
|
1030
|
+
*
|
|
1031
|
+
* @since 1.141
|
|
1032
|
+
*
|
|
1033
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
1034
|
+
*/
|
|
1035
|
+
indexOfCustomFont(
|
|
1036
|
+
/**
|
|
1037
|
+
* The customFont whose index is looked for
|
|
1038
|
+
*/
|
|
1039
|
+
oCustomFont: RichTextEditorFontFamily
|
|
1040
|
+
): int;
|
|
999
1041
|
/**
|
|
1000
1042
|
* Inserts a customButton into the aggregation {@link #getCustomButtons customButtons}.
|
|
1001
1043
|
*
|
|
@@ -1015,6 +1057,25 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
|
|
|
1015
1057
|
*/
|
|
1016
1058
|
iIndex: int
|
|
1017
1059
|
): this;
|
|
1060
|
+
/**
|
|
1061
|
+
* Inserts a customFont into the aggregation {@link #getCustomFonts customFonts}.
|
|
1062
|
+
*
|
|
1063
|
+
* @since 1.141
|
|
1064
|
+
*
|
|
1065
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1066
|
+
*/
|
|
1067
|
+
insertCustomFont(
|
|
1068
|
+
/**
|
|
1069
|
+
* The customFont to insert; if empty, nothing is inserted
|
|
1070
|
+
*/
|
|
1071
|
+
oCustomFont: RichTextEditorFontFamily,
|
|
1072
|
+
/**
|
|
1073
|
+
* The `0`-based index the customFont should be inserted at; for a negative value of `iIndex`, the customFont
|
|
1074
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the customFont
|
|
1075
|
+
* is inserted at the last position
|
|
1076
|
+
*/
|
|
1077
|
+
iIndex: int
|
|
1078
|
+
): this;
|
|
1018
1079
|
/**
|
|
1019
1080
|
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
|
|
1020
1081
|
*
|
|
@@ -1033,6 +1094,16 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
|
|
|
1033
1094
|
* @returns An array of the removed elements (might be empty)
|
|
1034
1095
|
*/
|
|
1035
1096
|
removeAllCustomButtons(): Control[];
|
|
1097
|
+
/**
|
|
1098
|
+
* Removes all the controls from the aggregation {@link #getCustomFonts customFonts}.
|
|
1099
|
+
*
|
|
1100
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
1101
|
+
*
|
|
1102
|
+
* @since 1.141
|
|
1103
|
+
*
|
|
1104
|
+
* @returns An array of the removed elements (might be empty)
|
|
1105
|
+
*/
|
|
1106
|
+
removeAllCustomFonts(): RichTextEditorFontFamily[];
|
|
1036
1107
|
/**
|
|
1037
1108
|
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
|
|
1038
1109
|
*
|
|
@@ -1071,6 +1142,19 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
|
|
|
1071
1142
|
*/
|
|
1072
1143
|
vCustomButton: int | string | Control
|
|
1073
1144
|
): Control | null;
|
|
1145
|
+
/**
|
|
1146
|
+
* Removes a customFont from the aggregation {@link #getCustomFonts customFonts}.
|
|
1147
|
+
*
|
|
1148
|
+
* @since 1.141
|
|
1149
|
+
*
|
|
1150
|
+
* @returns The removed customFont or `null`
|
|
1151
|
+
*/
|
|
1152
|
+
removeCustomFont(
|
|
1153
|
+
/**
|
|
1154
|
+
* The customFont to remove or its index or id
|
|
1155
|
+
*/
|
|
1156
|
+
vCustomFont: int | string | RichTextEditorFontFamily
|
|
1157
|
+
): RichTextEditorFontFamily | null;
|
|
1074
1158
|
/**
|
|
1075
1159
|
* Removes the plugin with the given name/ID from the list of plugins to load
|
|
1076
1160
|
*
|
|
@@ -1737,8 +1821,8 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
|
|
|
1737
1821
|
|
|
1738
1822
|
/**
|
|
1739
1823
|
* Custom buttons are meant to extend the `RichTextEditor`'s custom toolbar. Though type is set to sap.ui.Control,
|
|
1740
|
-
* only sap.m.Button is allowed. **Note:** customButtons are available only when the customToolbar is
|
|
1741
|
-
* and all the requirements are fulfilled.
|
|
1824
|
+
* only sap.m.Button is allowed. **Note:** customButtons are available only when the `customToolbar` is
|
|
1825
|
+
* enabled and all the requirements are fulfilled.
|
|
1742
1826
|
*
|
|
1743
1827
|
* @since 1.48
|
|
1744
1828
|
*/
|
|
@@ -1748,6 +1832,18 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
|
|
|
1748
1832
|
| AggregationBindingInfo
|
|
1749
1833
|
| `{${string}}`;
|
|
1750
1834
|
|
|
1835
|
+
/**
|
|
1836
|
+
* Custom font families that can be used in the `RichTextEditor`. **Note:** Custom fonts are available only
|
|
1837
|
+
* when the `customToolbar` is enabled.
|
|
1838
|
+
*
|
|
1839
|
+
* @since 1.141
|
|
1840
|
+
*/
|
|
1841
|
+
customFonts?:
|
|
1842
|
+
| RichTextEditorFontFamily[]
|
|
1843
|
+
| RichTextEditorFontFamily
|
|
1844
|
+
| AggregationBindingInfo
|
|
1845
|
+
| `{${string}}`;
|
|
1846
|
+
|
|
1751
1847
|
/**
|
|
1752
1848
|
* Association to controls / IDs which label this control (see WAI-ARIA attribute `aria-labelledby`).
|
|
1753
1849
|
*
|
|
@@ -1841,10 +1937,214 @@ declare module "sap/ui/richtexteditor/RichTextEditor" {
|
|
|
1841
1937
|
>;
|
|
1842
1938
|
}
|
|
1843
1939
|
|
|
1940
|
+
declare module "sap/ui/richtexteditor/RichTextEditorFontFamily" {
|
|
1941
|
+
import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
|
|
1942
|
+
|
|
1943
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
1944
|
+
|
|
1945
|
+
import { URI } from "sap/ui/core/library";
|
|
1946
|
+
|
|
1947
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
1948
|
+
|
|
1949
|
+
/**
|
|
1950
|
+
* Represents a font family option for `RichTextEditor`.
|
|
1951
|
+
*/
|
|
1952
|
+
export default class RichTextEditorFontFamily extends UI5Element {
|
|
1953
|
+
/**
|
|
1954
|
+
* Constructor for a new `RichTextEditorFontFamily`.
|
|
1955
|
+
*
|
|
1956
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1957
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1958
|
+
* of the syntax of the settings object.
|
|
1959
|
+
*/
|
|
1960
|
+
constructor(
|
|
1961
|
+
/**
|
|
1962
|
+
* initial settings for the new control
|
|
1963
|
+
*/
|
|
1964
|
+
mSettings?: $RichTextEditorFontFamilySettings
|
|
1965
|
+
);
|
|
1966
|
+
/**
|
|
1967
|
+
* Constructor for a new `RichTextEditorFontFamily`.
|
|
1968
|
+
*
|
|
1969
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1970
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1971
|
+
* of the syntax of the settings object.
|
|
1972
|
+
*/
|
|
1973
|
+
constructor(
|
|
1974
|
+
/**
|
|
1975
|
+
* id for the new control, generated automatically if no id is given
|
|
1976
|
+
*/
|
|
1977
|
+
sId?: string,
|
|
1978
|
+
/**
|
|
1979
|
+
* initial settings for the new control
|
|
1980
|
+
*/
|
|
1981
|
+
mSettings?: $RichTextEditorFontFamilySettings
|
|
1982
|
+
);
|
|
1983
|
+
|
|
1984
|
+
/**
|
|
1985
|
+
* Creates a new subclass of class sap.ui.richtexteditor.RichTextEditorFontFamily with name `sClassName`
|
|
1986
|
+
* and enriches it with the information contained in `oClassInfo`.
|
|
1987
|
+
*
|
|
1988
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
1989
|
+
*
|
|
1990
|
+
*
|
|
1991
|
+
* @returns Created class / constructor function
|
|
1992
|
+
*/
|
|
1993
|
+
static extend<T extends Record<string, unknown>>(
|
|
1994
|
+
/**
|
|
1995
|
+
* Name of the class being created
|
|
1996
|
+
*/
|
|
1997
|
+
sClassName: string,
|
|
1998
|
+
/**
|
|
1999
|
+
* Object literal with information about the class
|
|
2000
|
+
*/
|
|
2001
|
+
oClassInfo?: sap.ClassInfo<T, RichTextEditorFontFamily>,
|
|
2002
|
+
/**
|
|
2003
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2004
|
+
* used by this class
|
|
2005
|
+
*/
|
|
2006
|
+
FNMetaImpl?: Function
|
|
2007
|
+
): Function;
|
|
2008
|
+
/**
|
|
2009
|
+
* Returns a metadata object for class sap.ui.richtexteditor.RichTextEditorFontFamily.
|
|
2010
|
+
*
|
|
2011
|
+
*
|
|
2012
|
+
* @returns Metadata object describing this class
|
|
2013
|
+
*/
|
|
2014
|
+
static getMetadata(): ElementMetadata;
|
|
2015
|
+
/**
|
|
2016
|
+
* Gets current value of property {@link #getName name}.
|
|
2017
|
+
*
|
|
2018
|
+
* Used to identify the font in the editor. Names should be unique and descriptive.
|
|
2019
|
+
*
|
|
2020
|
+
*
|
|
2021
|
+
* @returns Value of property `name`
|
|
2022
|
+
*/
|
|
2023
|
+
getName(): string;
|
|
2024
|
+
/**
|
|
2025
|
+
* Gets current value of property {@link #getText text}.
|
|
2026
|
+
*
|
|
2027
|
+
* The text displayed in the font family dropdown.
|
|
2028
|
+
*
|
|
2029
|
+
*
|
|
2030
|
+
* @returns Value of property `text`
|
|
2031
|
+
*/
|
|
2032
|
+
getText(): string;
|
|
2033
|
+
/**
|
|
2034
|
+
* Gets current value of property {@link #getUrl url}.
|
|
2035
|
+
*
|
|
2036
|
+
* Used to load the font. The URL should point to a CSS file that defines the font-face.
|
|
2037
|
+
*
|
|
2038
|
+
*
|
|
2039
|
+
* @returns Value of property `url`
|
|
2040
|
+
*/
|
|
2041
|
+
getUrl(): URI;
|
|
2042
|
+
/**
|
|
2043
|
+
* Gets current value of property {@link #getValue value}.
|
|
2044
|
+
*
|
|
2045
|
+
* The value of the font family. CSS font-family value that will be applied to the text.
|
|
2046
|
+
*
|
|
2047
|
+
*
|
|
2048
|
+
* @returns Value of property `value`
|
|
2049
|
+
*/
|
|
2050
|
+
getValue(): string;
|
|
2051
|
+
/**
|
|
2052
|
+
* Sets a new value for property {@link #getName name}.
|
|
2053
|
+
*
|
|
2054
|
+
* Used to identify the font in the editor. Names should be unique and descriptive.
|
|
2055
|
+
*
|
|
2056
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2057
|
+
*
|
|
2058
|
+
*
|
|
2059
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2060
|
+
*/
|
|
2061
|
+
setName(
|
|
2062
|
+
/**
|
|
2063
|
+
* New value for property `name`
|
|
2064
|
+
*/
|
|
2065
|
+
sName?: string
|
|
2066
|
+
): this;
|
|
2067
|
+
/**
|
|
2068
|
+
* Sets a new value for property {@link #getText text}.
|
|
2069
|
+
*
|
|
2070
|
+
* The text displayed in the font family dropdown.
|
|
2071
|
+
*
|
|
2072
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2073
|
+
*
|
|
2074
|
+
*
|
|
2075
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2076
|
+
*/
|
|
2077
|
+
setText(
|
|
2078
|
+
/**
|
|
2079
|
+
* New value for property `text`
|
|
2080
|
+
*/
|
|
2081
|
+
sText?: string
|
|
2082
|
+
): this;
|
|
2083
|
+
/**
|
|
2084
|
+
* Sets a new value for property {@link #getUrl url}.
|
|
2085
|
+
*
|
|
2086
|
+
* Used to load the font. The URL should point to a CSS file that defines the font-face.
|
|
2087
|
+
*
|
|
2088
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2089
|
+
*
|
|
2090
|
+
*
|
|
2091
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2092
|
+
*/
|
|
2093
|
+
setUrl(
|
|
2094
|
+
/**
|
|
2095
|
+
* New value for property `url`
|
|
2096
|
+
*/
|
|
2097
|
+
sUrl?: URI
|
|
2098
|
+
): this;
|
|
2099
|
+
/**
|
|
2100
|
+
* Sets a new value for property {@link #getValue value}.
|
|
2101
|
+
*
|
|
2102
|
+
* The value of the font family. CSS font-family value that will be applied to the text.
|
|
2103
|
+
*
|
|
2104
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2105
|
+
*
|
|
2106
|
+
*
|
|
2107
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2108
|
+
*/
|
|
2109
|
+
setValue(
|
|
2110
|
+
/**
|
|
2111
|
+
* New value for property `value`
|
|
2112
|
+
*/
|
|
2113
|
+
sValue?: string
|
|
2114
|
+
): this;
|
|
2115
|
+
}
|
|
2116
|
+
/**
|
|
2117
|
+
* Describes the settings that can be provided to the RichTextEditorFontFamily constructor.
|
|
2118
|
+
*/
|
|
2119
|
+
export interface $RichTextEditorFontFamilySettings extends $ElementSettings {
|
|
2120
|
+
/**
|
|
2121
|
+
* Used to identify the font in the editor. Names should be unique and descriptive.
|
|
2122
|
+
*/
|
|
2123
|
+
name?: string | PropertyBindingInfo;
|
|
2124
|
+
|
|
2125
|
+
/**
|
|
2126
|
+
* The text displayed in the font family dropdown.
|
|
2127
|
+
*/
|
|
2128
|
+
text?: string | PropertyBindingInfo;
|
|
2129
|
+
|
|
2130
|
+
/**
|
|
2131
|
+
* The value of the font family. CSS font-family value that will be applied to the text.
|
|
2132
|
+
*/
|
|
2133
|
+
value?: string | PropertyBindingInfo;
|
|
2134
|
+
|
|
2135
|
+
/**
|
|
2136
|
+
* Used to load the font. The URL should point to a CSS file that defines the font-face.
|
|
2137
|
+
*/
|
|
2138
|
+
url?: URI | PropertyBindingInfo | `{${string}}`;
|
|
2139
|
+
}
|
|
2140
|
+
}
|
|
2141
|
+
|
|
1844
2142
|
declare namespace sap {
|
|
1845
2143
|
interface IUI5DefineDependencyNames {
|
|
1846
2144
|
"sap/ui/richtexteditor/library": undefined;
|
|
1847
2145
|
|
|
1848
2146
|
"sap/ui/richtexteditor/RichTextEditor": undefined;
|
|
2147
|
+
|
|
2148
|
+
"sap/ui/richtexteditor/RichTextEditorFontFamily": undefined;
|
|
1849
2149
|
}
|
|
1850
2150
|
}
|
package/types/sap.ui.rta.d.ts
CHANGED
package/types/sap.ui.suite.d.ts
CHANGED