@sapui5/ts-types-esm 1.143.2 → 1.144.1
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/index.d.ts +7 -7
- package/types/sap.apf.d.ts +3 -1
- package/types/sap.ca.ui.d.ts +8 -1
- package/types/sap.chart.d.ts +4 -4
- package/types/sap.collaboration.d.ts +1 -1
- package/types/sap.esh.search.ui.d.ts +846 -285
- package/types/sap.f.d.ts +4 -4
- package/types/sap.fe.ariba.d.ts +1 -1
- package/types/sap.fe.base.d.ts +1 -1
- package/types/sap.fe.controls.d.ts +1 -1
- package/types/sap.fe.core.d.ts +33 -6
- package/types/sap.fe.ina.d.ts +1 -1
- package/types/sap.fe.macros.d.ts +3591 -3495
- package/types/sap.fe.navigation.d.ts +7 -7
- 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 +18 -12
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +282 -10
- package/types/sap.insights.d.ts +1 -47
- package/types/{mobile-1.143.0-esm-d.ts → sap.m.d.ts} +298 -68
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +49 -21
- package/types/sap.ovp.d.ts +1 -1
- package/types/sap.rules.ui.d.ts +1 -1
- package/types/sap.sac.df.d.ts +1 -1
- package/types/sap.suite.ui.commons.d.ts +732 -6
- package/types/sap.suite.ui.generic.template.d.ts +1 -1
- package/types/sap.suite.ui.microchart.d.ts +1 -1
- package/types/{tnt-1.143.0-esm-d.ts → sap.tnt.d.ts} +5 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/{commons-1.143.0-esm-d.ts → sap.ui.commons.d.ts} +3469 -306
- package/types/sap.ui.comp.d.ts +3 -3
- package/types/{core-1.143.0-esm-d.ts → sap.ui.core.d.ts} +621 -166
- package/types/{dt-1.143.0-esm-d.ts → sap.ui.dt.d.ts} +1 -1
- package/types/sap.ui.export.d.ts +4 -4
- package/types/sap.ui.fl.d.ts +5 -5
- package/types/sap.ui.generic.app.d.ts +1 -1
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.geomap.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +1 -1
- package/types/sap.ui.layout.d.ts +18 -18
- package/types/{mdc-1.143.0-esm-d.ts → sap.ui.mdc.d.ts} +105 -67
- package/types/sap.ui.richtexteditor.d.ts +3 -3
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +3 -1
- package/types/sap.ui.support.d.ts +1 -1
- package/types/sap.ui.table.d.ts +1 -1
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +126 -4
- package/types/{ux3-1.143.0-esm-d.ts → sap.ui.ux3.d.ts} +1 -1
- package/types/sap.ui.vbm.d.ts +1 -1
- package/types/sap.ui.vk.d.ts +139 -4
- package/types/sap.ui.vtm.d.ts +100 -1
- package/types/sap.ui.webc.common.d.ts +3 -1
- package/types/sap.ui.webc.fiori.d.ts +31 -1
- package/types/sap.ui.webc.main.d.ts +70 -1
- package/types/sap.uiext.inbox.d.ts +1 -1
- package/types/sap.ushell.d.ts +15 -1
- package/types/sap.ushell_abap.d.ts +1 -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
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.144.0
|
|
2
2
|
|
|
3
3
|
declare module "sap/ui/commons/library" {
|
|
4
4
|
import { ColorPickerMode as ColorPickerMode1 } from "sap/ui/unified/library";
|
|
@@ -97,6 +97,35 @@ declare module "sap/ui/commons/library" {
|
|
|
97
97
|
*/
|
|
98
98
|
Page = "Page",
|
|
99
99
|
}
|
|
100
|
+
/**
|
|
101
|
+
* Marker interface for controls that process instances of `window.Blob`, such as `window.File`. The implementation
|
|
102
|
+
* of this Interface should implement the following Interface methods:
|
|
103
|
+
* - `getProcessedBlobsFromArray`
|
|
104
|
+
*
|
|
105
|
+
* @deprecated As of version 1.38. because it is part of the deprecated package sap.ui.commons
|
|
106
|
+
*/
|
|
107
|
+
export interface IProcessableBlobs {
|
|
108
|
+
__implements__sap_ui_commons_IProcessableBlobs: boolean;
|
|
109
|
+
|
|
110
|
+
/**
|
|
111
|
+
* Allows to process Blobs before they get uploaded. This API can be used to create custom Blobs and upload
|
|
112
|
+
* these custom Blobs instead of the received/initials Blobs in the parameter `aBlobs`. One use case could
|
|
113
|
+
* be to create and upload zip archives based on the passed Blobs. The default implementation of this API
|
|
114
|
+
* should simply resolve with the received Blobs (parameter `aBlobs`).
|
|
115
|
+
*
|
|
116
|
+
* @since 1.144
|
|
117
|
+
* @deprecated As of version 1.144. Please use the IProcessableBlobs of the library sap.ui.unified instead.
|
|
118
|
+
*
|
|
119
|
+
* @returns A Promise that resolves with an array of Blobs which is used for the final uploading.
|
|
120
|
+
*/
|
|
121
|
+
getProcessedBlobsFromArray(
|
|
122
|
+
/**
|
|
123
|
+
* The initial Blobs which can be used to determine a new array of Blobs for further processing.
|
|
124
|
+
*/
|
|
125
|
+
aBlobs: Blob[]
|
|
126
|
+
): Promise<Blob[]>;
|
|
127
|
+
}
|
|
128
|
+
|
|
100
129
|
/**
|
|
101
130
|
* Available label display modes.
|
|
102
131
|
*
|
|
@@ -7686,392 +7715,3423 @@ declare module "sap/ui/commons/DropdownBox" {
|
|
|
7686
7715
|
*
|
|
7687
7716
|
* @returns Value of property `maxHistoryItems`
|
|
7688
7717
|
*/
|
|
7689
|
-
getMaxHistoryItems(): int;
|
|
7718
|
+
getMaxHistoryItems(): int;
|
|
7719
|
+
/**
|
|
7720
|
+
* Gets current value of property {@link #getSearchHelpAdditionalText searchHelpAdditionalText}.
|
|
7721
|
+
*
|
|
7722
|
+
* (optional) The additional Text to use for the search help entry.
|
|
7723
|
+
*
|
|
7724
|
+
*
|
|
7725
|
+
* @returns Value of property `searchHelpAdditionalText`
|
|
7726
|
+
*/
|
|
7727
|
+
getSearchHelpAdditionalText(): string;
|
|
7728
|
+
/**
|
|
7729
|
+
* Gets current value of property {@link #getSearchHelpEnabled searchHelpEnabled}.
|
|
7730
|
+
*
|
|
7731
|
+
* Whether the DropdownBox's search help should be enabled.
|
|
7732
|
+
*
|
|
7733
|
+
* Default value is `false`.
|
|
7734
|
+
*
|
|
7735
|
+
*
|
|
7736
|
+
* @returns Value of property `searchHelpEnabled`
|
|
7737
|
+
*/
|
|
7738
|
+
getSearchHelpEnabled(): boolean;
|
|
7739
|
+
/**
|
|
7740
|
+
* Gets current value of property {@link #getSearchHelpIcon searchHelpIcon}.
|
|
7741
|
+
*
|
|
7742
|
+
* (optional) The URI of the icon to use for the search help entry.
|
|
7743
|
+
*
|
|
7744
|
+
*
|
|
7745
|
+
* @returns Value of property `searchHelpIcon`
|
|
7746
|
+
*/
|
|
7747
|
+
getSearchHelpIcon(): URI;
|
|
7748
|
+
/**
|
|
7749
|
+
* Gets current value of property {@link #getSearchHelpText searchHelpText}.
|
|
7750
|
+
*
|
|
7751
|
+
* (optional) The text to use for the search help entry.
|
|
7752
|
+
*
|
|
7753
|
+
*
|
|
7754
|
+
* @returns Value of property `searchHelpText`
|
|
7755
|
+
*/
|
|
7756
|
+
getSearchHelpText(): string;
|
|
7757
|
+
/**
|
|
7758
|
+
* Overrides the method inherited from {@link sap.ui.core.Element} by providing information on Search Help
|
|
7759
|
+
* access (if needed)
|
|
7760
|
+
*
|
|
7761
|
+
*
|
|
7762
|
+
* @returns string tooltip or `undefined`
|
|
7763
|
+
*/
|
|
7764
|
+
getTooltip_AsString(): string | undefined;
|
|
7765
|
+
/**
|
|
7766
|
+
* Ensure that handed in ListBoxes are taken from the visible UI immediately.
|
|
7767
|
+
*
|
|
7768
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7769
|
+
*/
|
|
7770
|
+
onAfterRendering(
|
|
7771
|
+
/**
|
|
7772
|
+
* The event object.
|
|
7773
|
+
*/
|
|
7774
|
+
oEvent: jQuery.Event
|
|
7775
|
+
): void;
|
|
7776
|
+
/**
|
|
7777
|
+
* Handle the click event happening in the DropdownBox
|
|
7778
|
+
*
|
|
7779
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7780
|
+
*/
|
|
7781
|
+
onclick(
|
|
7782
|
+
/**
|
|
7783
|
+
* The event object.
|
|
7784
|
+
*/
|
|
7785
|
+
oEvent: jQuery.Event
|
|
7786
|
+
): void;
|
|
7787
|
+
/**
|
|
7788
|
+
* Handle focusin event Ensures the text gets selected when focus gets into the field
|
|
7789
|
+
*
|
|
7790
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7791
|
+
*/
|
|
7792
|
+
onfocusin(
|
|
7793
|
+
/**
|
|
7794
|
+
* the occuring event
|
|
7795
|
+
*/
|
|
7796
|
+
oEvent: jQuery.Event
|
|
7797
|
+
): void;
|
|
7798
|
+
/**
|
|
7799
|
+
* Handle keydown event
|
|
7800
|
+
*
|
|
7801
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7802
|
+
*/
|
|
7803
|
+
onkeydown(
|
|
7804
|
+
/**
|
|
7805
|
+
* the occuring event
|
|
7806
|
+
*/
|
|
7807
|
+
oEvent: jQuery.Event
|
|
7808
|
+
): void;
|
|
7809
|
+
/**
|
|
7810
|
+
* Handle keypress event
|
|
7811
|
+
*
|
|
7812
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7813
|
+
*/
|
|
7814
|
+
onkeypress(
|
|
7815
|
+
/**
|
|
7816
|
+
* the occuring event
|
|
7817
|
+
*/
|
|
7818
|
+
oEvent: jQuery.Event
|
|
7819
|
+
): void;
|
|
7820
|
+
/**
|
|
7821
|
+
* Handle keyup event This must only be considered if it is from Backspace-key in IE or after paste. In
|
|
7822
|
+
* case there is a keyup with a tab this results from being entered via tabbing and can be ignored, too.
|
|
7823
|
+
*
|
|
7824
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7825
|
+
*/
|
|
7826
|
+
onkeyup(
|
|
7827
|
+
/**
|
|
7828
|
+
* the occuring event
|
|
7829
|
+
*/
|
|
7830
|
+
oEvent: jQuery.Event
|
|
7831
|
+
): void;
|
|
7832
|
+
/**
|
|
7833
|
+
* Handle paste event
|
|
7834
|
+
*
|
|
7835
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7836
|
+
*/
|
|
7837
|
+
onpaste(
|
|
7838
|
+
/**
|
|
7839
|
+
* the occuring event
|
|
7840
|
+
*/
|
|
7841
|
+
oEvent: jQuery.Event
|
|
7842
|
+
): void;
|
|
7843
|
+
/**
|
|
7844
|
+
* Handle pseudo event onsapdelete. If triggered with open dropdown and current item provided by history
|
|
7845
|
+
* feature, removes the selected item from this instance's history.
|
|
7846
|
+
*
|
|
7847
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7848
|
+
*/
|
|
7849
|
+
onsapdelete(
|
|
7850
|
+
/**
|
|
7851
|
+
* the occuring event
|
|
7852
|
+
*/
|
|
7853
|
+
oEvent: jQuery.Event
|
|
7854
|
+
): void;
|
|
7855
|
+
/**
|
|
7856
|
+
* Handle pseudo event onsaphome
|
|
7857
|
+
*
|
|
7858
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7859
|
+
*/
|
|
7860
|
+
onsaphome(
|
|
7861
|
+
/**
|
|
7862
|
+
* the occuring event
|
|
7863
|
+
*/
|
|
7864
|
+
oEvent: jQuery.Event
|
|
7865
|
+
): void;
|
|
7866
|
+
/**
|
|
7867
|
+
* Move the cursor one step to the left (and adapt selection)
|
|
7868
|
+
*
|
|
7869
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7870
|
+
*/
|
|
7871
|
+
onsapleft(
|
|
7872
|
+
/**
|
|
7873
|
+
* The event object.
|
|
7874
|
+
*/
|
|
7875
|
+
oEvent: jQuery.Event
|
|
7876
|
+
): void;
|
|
7877
|
+
/**
|
|
7878
|
+
* Move the cursor one step to the right (and adapt selection)
|
|
7879
|
+
*
|
|
7880
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7881
|
+
*/
|
|
7882
|
+
onsapright(
|
|
7883
|
+
/**
|
|
7884
|
+
* The event object.
|
|
7885
|
+
*/
|
|
7886
|
+
oEvent: jQuery.Event
|
|
7887
|
+
): void;
|
|
7888
|
+
/**
|
|
7889
|
+
* Handle sapshow pseudo events on the control
|
|
7890
|
+
*
|
|
7891
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7892
|
+
*/
|
|
7893
|
+
onsapshow(
|
|
7894
|
+
/**
|
|
7895
|
+
* The event object.
|
|
7896
|
+
*/
|
|
7897
|
+
oEvent: jQuery.Event
|
|
7898
|
+
): void;
|
|
7899
|
+
/**
|
|
7900
|
+
* Handle the select event happening in the DropdownBox
|
|
7901
|
+
*
|
|
7902
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7903
|
+
*/
|
|
7904
|
+
onselect(
|
|
7905
|
+
/**
|
|
7906
|
+
* The event object.
|
|
7907
|
+
*/
|
|
7908
|
+
oEvent: jQuery.Event
|
|
7909
|
+
): void;
|
|
7910
|
+
/**
|
|
7911
|
+
* Sets a new value for property {@link #getMaxHistoryItems maxHistoryItems}.
|
|
7912
|
+
*
|
|
7913
|
+
* Maximum number of history items in the list.
|
|
7914
|
+
*
|
|
7915
|
+
* If 0 no history is displayed or stored. The history is locally stored on the client. Therefore do not
|
|
7916
|
+
* activate this feature when this control handles confidential data.
|
|
7917
|
+
*
|
|
7918
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7919
|
+
*
|
|
7920
|
+
* Default value is `0`.
|
|
7921
|
+
*
|
|
7922
|
+
*
|
|
7923
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
7924
|
+
*/
|
|
7925
|
+
setMaxHistoryItems(
|
|
7926
|
+
/**
|
|
7927
|
+
* New value for property `maxHistoryItems`
|
|
7928
|
+
*/
|
|
7929
|
+
iMaxHistoryItems?: int
|
|
7930
|
+
): this;
|
|
7931
|
+
/**
|
|
7932
|
+
* Overwrite of Setter for property `searchHelpAdditionalText`.
|
|
7933
|
+
*
|
|
7934
|
+
* Default value is empty/`undefined`
|
|
7935
|
+
*
|
|
7936
|
+
*
|
|
7937
|
+
* @returns `this` to allow method chaining
|
|
7938
|
+
*/
|
|
7939
|
+
setSearchHelpAdditionalText(
|
|
7940
|
+
/**
|
|
7941
|
+
* new value for property `searchHelpAdditionalText`
|
|
7942
|
+
*/
|
|
7943
|
+
sSearchHelpAdditionalText: string
|
|
7944
|
+
): this;
|
|
7945
|
+
/**
|
|
7946
|
+
* Overwrite of Setter for property `searchHelpEnabled`. This method accepts additional parameter to be
|
|
7947
|
+
* compatiple with the previous functionality
|
|
7948
|
+
*
|
|
7949
|
+
* Default value is `false`
|
|
7950
|
+
*
|
|
7951
|
+
*
|
|
7952
|
+
* @returns `this` to allow method chaining
|
|
7953
|
+
*/
|
|
7954
|
+
setSearchHelpEnabled(
|
|
7955
|
+
/**
|
|
7956
|
+
* new value for property `searchHelpEnabled`
|
|
7957
|
+
*/
|
|
7958
|
+
bEnabled: boolean,
|
|
7959
|
+
/**
|
|
7960
|
+
* new value for property `searchHelpText`
|
|
7961
|
+
*/
|
|
7962
|
+
sText: string,
|
|
7963
|
+
/**
|
|
7964
|
+
* new value for property `searchHelpAdditionalText`
|
|
7965
|
+
*/
|
|
7966
|
+
sAdditionalText: string,
|
|
7967
|
+
/**
|
|
7968
|
+
* new value for property `searchHelpIcon`
|
|
7969
|
+
*/
|
|
7970
|
+
sIcon: string
|
|
7971
|
+
): this;
|
|
7972
|
+
/**
|
|
7973
|
+
* Overwrite of Setter for property `searchHelpIcon`.
|
|
7974
|
+
*
|
|
7975
|
+
* Default value is empty/`undefined`
|
|
7976
|
+
*
|
|
7977
|
+
*
|
|
7978
|
+
* @returns `this` to allow method chaining
|
|
7979
|
+
*/
|
|
7980
|
+
setSearchHelpIcon(
|
|
7981
|
+
/**
|
|
7982
|
+
* new value for property `searchHelpIcon`
|
|
7983
|
+
*/
|
|
7984
|
+
sSearchHelpIcon: URI
|
|
7985
|
+
): this;
|
|
7986
|
+
/**
|
|
7987
|
+
* Overwrite of Setter for property `searchHelpText`.
|
|
7988
|
+
*
|
|
7989
|
+
* Default value is empty/`undefined`
|
|
7990
|
+
*
|
|
7991
|
+
*
|
|
7992
|
+
* @returns `this` to allow method chaining
|
|
7993
|
+
*/
|
|
7994
|
+
setSearchHelpText(
|
|
7995
|
+
/**
|
|
7996
|
+
* new value for property `searchHelpText`
|
|
7997
|
+
*/
|
|
7998
|
+
sSearchHelpText: string
|
|
7999
|
+
): this;
|
|
8000
|
+
}
|
|
8001
|
+
/**
|
|
8002
|
+
* Describes the settings that can be provided to the DropdownBox constructor.
|
|
8003
|
+
*
|
|
8004
|
+
* @deprecated As of version 1.38. replaced by {@link sap.m.ComboBox}
|
|
8005
|
+
*/
|
|
8006
|
+
export interface $DropdownBoxSettings extends $ComboBoxSettings {
|
|
8007
|
+
/**
|
|
8008
|
+
* Whether the DropdownBox's search help should be enabled.
|
|
8009
|
+
*/
|
|
8010
|
+
searchHelpEnabled?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
8011
|
+
|
|
8012
|
+
/**
|
|
8013
|
+
* (optional) The text to use for the search help entry.
|
|
8014
|
+
*/
|
|
8015
|
+
searchHelpText?: string | PropertyBindingInfo;
|
|
8016
|
+
|
|
8017
|
+
/**
|
|
8018
|
+
* (optional) The additional Text to use for the search help entry.
|
|
8019
|
+
*/
|
|
8020
|
+
searchHelpAdditionalText?: string | PropertyBindingInfo;
|
|
8021
|
+
|
|
8022
|
+
/**
|
|
8023
|
+
* (optional) The URI of the icon to use for the search help entry.
|
|
8024
|
+
*/
|
|
8025
|
+
searchHelpIcon?: URI | PropertyBindingInfo | `{${string}}`;
|
|
8026
|
+
|
|
8027
|
+
/**
|
|
8028
|
+
* Maximum number of history items in the list.
|
|
8029
|
+
*
|
|
8030
|
+
* If 0 no history is displayed or stored. The history is locally stored on the client. Therefore do not
|
|
8031
|
+
* activate this feature when this control handles confidential data.
|
|
8032
|
+
*/
|
|
8033
|
+
maxHistoryItems?: int | PropertyBindingInfo | `{${string}}`;
|
|
8034
|
+
|
|
8035
|
+
/**
|
|
8036
|
+
* Event fired whenever the configured searchHelpItem is clicked or the searchHelpItem is configured and
|
|
8037
|
+
* F4 key is pressed.
|
|
8038
|
+
*/
|
|
8039
|
+
searchHelp?: (oEvent: DropdownBox$SearchHelpEvent) => void;
|
|
8040
|
+
}
|
|
8041
|
+
|
|
8042
|
+
/**
|
|
8043
|
+
* Parameters of the DropdownBox#searchHelp event.
|
|
8044
|
+
*/
|
|
8045
|
+
export interface DropdownBox$SearchHelpEventParameters {
|
|
8046
|
+
/**
|
|
8047
|
+
* The current value of the DropdownBox.
|
|
8048
|
+
*/
|
|
8049
|
+
value?: string;
|
|
8050
|
+
}
|
|
8051
|
+
|
|
8052
|
+
/**
|
|
8053
|
+
* Event object of the DropdownBox#searchHelp event.
|
|
8054
|
+
*/
|
|
8055
|
+
export type DropdownBox$SearchHelpEvent = Event<
|
|
8056
|
+
DropdownBox$SearchHelpEventParameters,
|
|
8057
|
+
DropdownBox
|
|
8058
|
+
>;
|
|
8059
|
+
}
|
|
8060
|
+
|
|
8061
|
+
declare module "sap/ui/commons/FileUploader" {
|
|
8062
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
8063
|
+
|
|
8064
|
+
import {
|
|
8065
|
+
IFormContent,
|
|
8066
|
+
ID,
|
|
8067
|
+
URI,
|
|
8068
|
+
ValueState,
|
|
8069
|
+
CSSSize,
|
|
8070
|
+
} from "sap/ui/core/library";
|
|
8071
|
+
|
|
8072
|
+
import { IProcessableBlobs } from "sap/ui/commons/library";
|
|
8073
|
+
|
|
8074
|
+
import FileUploaderParameter from "sap/ui/commons/FileUploaderParameter";
|
|
8075
|
+
|
|
8076
|
+
import Event from "sap/ui/base/Event";
|
|
8077
|
+
|
|
8078
|
+
import FileUploaderHttpRequestMethod from "sap/ui/commons/FileUploaderHttpRequestMethod";
|
|
8079
|
+
|
|
8080
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
8081
|
+
|
|
8082
|
+
import FileUploaderXHRSettings from "sap/ui/commons/FileUploaderXHRSettings";
|
|
8083
|
+
|
|
8084
|
+
import {
|
|
8085
|
+
PropertyBindingInfo,
|
|
8086
|
+
AggregationBindingInfo,
|
|
8087
|
+
} from "sap/ui/base/ManagedObject";
|
|
8088
|
+
|
|
8089
|
+
/**
|
|
8090
|
+
* The framework generates an input field and a button with text "Browse ...". The API supports features
|
|
8091
|
+
* such as on change uploads (the upload starts immediately after a file has been selected), file uploads
|
|
8092
|
+
* with explicit calls, adjustable control sizes, text display after uploads, or tooltips containing complete
|
|
8093
|
+
* file paths.
|
|
8094
|
+
*
|
|
8095
|
+
* @deprecated As of version 1.21.0. Please use the control sap.ui.unified.FileUploader of the library sap.ui.unified
|
|
8096
|
+
* instead.
|
|
8097
|
+
*/
|
|
8098
|
+
export default class FileUploader
|
|
8099
|
+
extends Control
|
|
8100
|
+
implements IFormContent, IProcessableBlobs
|
|
8101
|
+
{
|
|
8102
|
+
__implements__sap_ui_core_IFormContent: boolean;
|
|
8103
|
+
__implements__sap_ui_commons_IProcessableBlobs: boolean;
|
|
8104
|
+
/**
|
|
8105
|
+
* Constructor for a new FileUploader.
|
|
8106
|
+
*
|
|
8107
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
8108
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
8109
|
+
* of the syntax of the settings object.
|
|
8110
|
+
*/
|
|
8111
|
+
constructor(
|
|
8112
|
+
/**
|
|
8113
|
+
* initial settings for the new control
|
|
8114
|
+
*/
|
|
8115
|
+
mSettings?: $FileUploaderSettings
|
|
8116
|
+
);
|
|
8117
|
+
/**
|
|
8118
|
+
* Constructor for a new FileUploader.
|
|
8119
|
+
*
|
|
8120
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
8121
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
8122
|
+
* of the syntax of the settings object.
|
|
8123
|
+
*/
|
|
8124
|
+
constructor(
|
|
8125
|
+
/**
|
|
8126
|
+
* id for the new control, generated automatically if no id is given
|
|
8127
|
+
*/
|
|
8128
|
+
sId?: string,
|
|
8129
|
+
/**
|
|
8130
|
+
* initial settings for the new control
|
|
8131
|
+
*/
|
|
8132
|
+
mSettings?: $FileUploaderSettings
|
|
8133
|
+
);
|
|
8134
|
+
|
|
8135
|
+
/**
|
|
8136
|
+
* Creates a new subclass of class sap.ui.commons.FileUploader with name `sClassName` and enriches it with
|
|
8137
|
+
* the information contained in `oClassInfo`.
|
|
8138
|
+
*
|
|
8139
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
8140
|
+
*
|
|
8141
|
+
*
|
|
8142
|
+
* @returns Created class / constructor function
|
|
8143
|
+
*/
|
|
8144
|
+
static extend<T extends Record<string, unknown>>(
|
|
8145
|
+
/**
|
|
8146
|
+
* Name of the class being created
|
|
8147
|
+
*/
|
|
8148
|
+
sClassName: string,
|
|
8149
|
+
/**
|
|
8150
|
+
* Object literal with information about the class
|
|
8151
|
+
*/
|
|
8152
|
+
oClassInfo?: sap.ClassInfo<T, FileUploader>,
|
|
8153
|
+
/**
|
|
8154
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
8155
|
+
* used by this class
|
|
8156
|
+
*/
|
|
8157
|
+
FNMetaImpl?: Function
|
|
8158
|
+
): Function;
|
|
8159
|
+
/**
|
|
8160
|
+
* Returns a metadata object for class sap.ui.commons.FileUploader.
|
|
8161
|
+
*
|
|
8162
|
+
*
|
|
8163
|
+
* @returns Metadata object describing this class
|
|
8164
|
+
*/
|
|
8165
|
+
static getMetadata(): ElementMetadata;
|
|
8166
|
+
/**
|
|
8167
|
+
* Aborts the currently running upload.
|
|
8168
|
+
*
|
|
8169
|
+
* @since 1.24.0
|
|
8170
|
+
*/
|
|
8171
|
+
abort(
|
|
8172
|
+
/**
|
|
8173
|
+
* The name of the parameter within the `headerParameters` aggregation to be checked.
|
|
8174
|
+
*
|
|
8175
|
+
* **Note:** aborts the request, sent with a header parameter with the provided name. The parameter is taken
|
|
8176
|
+
* into account if the sHeaderParameterValue parameter is provided too.
|
|
8177
|
+
*/
|
|
8178
|
+
sHeaderParameterName: string,
|
|
8179
|
+
/**
|
|
8180
|
+
* The value of the parameter within the `headerParameters` aggregation to be checked.
|
|
8181
|
+
*
|
|
8182
|
+
* **Note:** aborts the request, sent with a header parameter with the provided value. The parameter is
|
|
8183
|
+
* taken into account if the sHeaderParameterName parameter is provided too.
|
|
8184
|
+
*/
|
|
8185
|
+
sHeaderParameterValue: string
|
|
8186
|
+
): void;
|
|
8187
|
+
/**
|
|
8188
|
+
* Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
|
|
8189
|
+
*
|
|
8190
|
+
*
|
|
8191
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8192
|
+
*/
|
|
8193
|
+
addAriaDescribedBy(
|
|
8194
|
+
/**
|
|
8195
|
+
* The ariaDescribedBy to add; if empty, nothing is inserted
|
|
8196
|
+
*/
|
|
8197
|
+
vAriaDescribedBy: ID | Control
|
|
8198
|
+
): this;
|
|
8199
|
+
/**
|
|
8200
|
+
* Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
|
|
8201
|
+
*
|
|
8202
|
+
*
|
|
8203
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8204
|
+
*/
|
|
8205
|
+
addAriaLabelledBy(
|
|
8206
|
+
/**
|
|
8207
|
+
* The ariaLabelledBy to add; if empty, nothing is inserted
|
|
8208
|
+
*/
|
|
8209
|
+
vAriaLabelledBy: ID | Control
|
|
8210
|
+
): this;
|
|
8211
|
+
/**
|
|
8212
|
+
* Adds some headerParameter to the aggregation {@link #getHeaderParameters headerParameters}.
|
|
8213
|
+
*
|
|
8214
|
+
*
|
|
8215
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8216
|
+
*/
|
|
8217
|
+
addHeaderParameter(
|
|
8218
|
+
/**
|
|
8219
|
+
* The headerParameter to add; if empty, nothing is inserted
|
|
8220
|
+
*/
|
|
8221
|
+
oHeaderParameter: FileUploaderParameter
|
|
8222
|
+
): this;
|
|
8223
|
+
/**
|
|
8224
|
+
* Adds some parameter to the aggregation {@link #getParameters parameters}.
|
|
8225
|
+
*
|
|
8226
|
+
* @since 1.12.2
|
|
8227
|
+
*
|
|
8228
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8229
|
+
*/
|
|
8230
|
+
addParameter(
|
|
8231
|
+
/**
|
|
8232
|
+
* The parameter to add; if empty, nothing is inserted
|
|
8233
|
+
*/
|
|
8234
|
+
oParameter: FileUploaderParameter
|
|
8235
|
+
): this;
|
|
8236
|
+
/**
|
|
8237
|
+
* Attaches event handler `fnFunction` to the {@link #event:afterDialogClose afterDialogClose} event of
|
|
8238
|
+
* this `sap.ui.commons.FileUploader`.
|
|
8239
|
+
*
|
|
8240
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8241
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8242
|
+
*
|
|
8243
|
+
* Fired after select file dialog closes.
|
|
8244
|
+
*
|
|
8245
|
+
* @since 1.102.0
|
|
8246
|
+
*
|
|
8247
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8248
|
+
*/
|
|
8249
|
+
attachAfterDialogClose(
|
|
8250
|
+
/**
|
|
8251
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
8252
|
+
* object when firing the event
|
|
8253
|
+
*/
|
|
8254
|
+
oData: object,
|
|
8255
|
+
/**
|
|
8256
|
+
* The function to be called when the event occurs
|
|
8257
|
+
*/
|
|
8258
|
+
fnFunction: (p1: Event) => void,
|
|
8259
|
+
/**
|
|
8260
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8261
|
+
*/
|
|
8262
|
+
oListener?: object
|
|
8263
|
+
): this;
|
|
8264
|
+
/**
|
|
8265
|
+
* Attaches event handler `fnFunction` to the {@link #event:afterDialogClose afterDialogClose} event of
|
|
8266
|
+
* this `sap.ui.commons.FileUploader`.
|
|
8267
|
+
*
|
|
8268
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8269
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8270
|
+
*
|
|
8271
|
+
* Fired after select file dialog closes.
|
|
8272
|
+
*
|
|
8273
|
+
* @since 1.102.0
|
|
8274
|
+
*
|
|
8275
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8276
|
+
*/
|
|
8277
|
+
attachAfterDialogClose(
|
|
8278
|
+
/**
|
|
8279
|
+
* The function to be called when the event occurs
|
|
8280
|
+
*/
|
|
8281
|
+
fnFunction: (p1: Event) => void,
|
|
8282
|
+
/**
|
|
8283
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8284
|
+
*/
|
|
8285
|
+
oListener?: object
|
|
8286
|
+
): this;
|
|
8287
|
+
/**
|
|
8288
|
+
* Attaches event handler `fnFunction` to the {@link #event:beforeDialogOpen beforeDialogOpen} event of
|
|
8289
|
+
* this `sap.ui.commons.FileUploader`.
|
|
8290
|
+
*
|
|
8291
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8292
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8293
|
+
*
|
|
8294
|
+
* Fired before select file dialog opens.
|
|
8295
|
+
*
|
|
8296
|
+
* @since 1.102.0
|
|
8297
|
+
*
|
|
8298
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8299
|
+
*/
|
|
8300
|
+
attachBeforeDialogOpen(
|
|
8301
|
+
/**
|
|
8302
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
8303
|
+
* object when firing the event
|
|
8304
|
+
*/
|
|
8305
|
+
oData: object,
|
|
8306
|
+
/**
|
|
8307
|
+
* The function to be called when the event occurs
|
|
8308
|
+
*/
|
|
8309
|
+
fnFunction: (p1: Event) => void,
|
|
8310
|
+
/**
|
|
8311
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8312
|
+
*/
|
|
8313
|
+
oListener?: object
|
|
8314
|
+
): this;
|
|
8315
|
+
/**
|
|
8316
|
+
* Attaches event handler `fnFunction` to the {@link #event:beforeDialogOpen beforeDialogOpen} event of
|
|
8317
|
+
* this `sap.ui.commons.FileUploader`.
|
|
8318
|
+
*
|
|
8319
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8320
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8321
|
+
*
|
|
8322
|
+
* Fired before select file dialog opens.
|
|
8323
|
+
*
|
|
8324
|
+
* @since 1.102.0
|
|
8325
|
+
*
|
|
8326
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8327
|
+
*/
|
|
8328
|
+
attachBeforeDialogOpen(
|
|
8329
|
+
/**
|
|
8330
|
+
* The function to be called when the event occurs
|
|
8331
|
+
*/
|
|
8332
|
+
fnFunction: (p1: Event) => void,
|
|
8333
|
+
/**
|
|
8334
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8335
|
+
*/
|
|
8336
|
+
oListener?: object
|
|
8337
|
+
): this;
|
|
8338
|
+
/**
|
|
8339
|
+
* Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.commons.FileUploader`.
|
|
8340
|
+
*
|
|
8341
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8342
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8343
|
+
*
|
|
8344
|
+
* Event is fired when the value of the file path has been changed.
|
|
8345
|
+
*
|
|
8346
|
+
* **Note:** Keep in mind that because of the HTML input element of type file, the event is also fired in
|
|
8347
|
+
* Chrome browser when the Cancel button of the uploads window is pressed.
|
|
8348
|
+
*
|
|
8349
|
+
*
|
|
8350
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8351
|
+
*/
|
|
8352
|
+
attachChange(
|
|
8353
|
+
/**
|
|
8354
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
8355
|
+
* object when firing the event
|
|
8356
|
+
*/
|
|
8357
|
+
oData: object,
|
|
8358
|
+
/**
|
|
8359
|
+
* The function to be called when the event occurs
|
|
8360
|
+
*/
|
|
8361
|
+
fnFunction: (p1: FileUploader$ChangeEvent) => void,
|
|
8362
|
+
/**
|
|
8363
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8364
|
+
*/
|
|
8365
|
+
oListener?: object
|
|
8366
|
+
): this;
|
|
8367
|
+
/**
|
|
8368
|
+
* Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.commons.FileUploader`.
|
|
8369
|
+
*
|
|
8370
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8371
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8372
|
+
*
|
|
8373
|
+
* Event is fired when the value of the file path has been changed.
|
|
8374
|
+
*
|
|
8375
|
+
* **Note:** Keep in mind that because of the HTML input element of type file, the event is also fired in
|
|
8376
|
+
* Chrome browser when the Cancel button of the uploads window is pressed.
|
|
8377
|
+
*
|
|
8378
|
+
*
|
|
8379
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8380
|
+
*/
|
|
8381
|
+
attachChange(
|
|
8382
|
+
/**
|
|
8383
|
+
* The function to be called when the event occurs
|
|
8384
|
+
*/
|
|
8385
|
+
fnFunction: (p1: FileUploader$ChangeEvent) => void,
|
|
8386
|
+
/**
|
|
8387
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8388
|
+
*/
|
|
8389
|
+
oListener?: object
|
|
8390
|
+
): this;
|
|
8391
|
+
/**
|
|
8392
|
+
* Attaches event handler `fnFunction` to the {@link #event:fileAllowed fileAllowed} event of this `sap.ui.commons.FileUploader`.
|
|
8393
|
+
*
|
|
8394
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8395
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8396
|
+
*
|
|
8397
|
+
* Event is fired when the file is allowed for upload on client side.
|
|
8398
|
+
*
|
|
8399
|
+
*
|
|
8400
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8401
|
+
*/
|
|
8402
|
+
attachFileAllowed(
|
|
8403
|
+
/**
|
|
8404
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
8405
|
+
* object when firing the event
|
|
8406
|
+
*/
|
|
8407
|
+
oData: object,
|
|
8408
|
+
/**
|
|
8409
|
+
* The function to be called when the event occurs
|
|
8410
|
+
*/
|
|
8411
|
+
fnFunction: (p1: Event) => void,
|
|
8412
|
+
/**
|
|
8413
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8414
|
+
*/
|
|
8415
|
+
oListener?: object
|
|
8416
|
+
): this;
|
|
8417
|
+
/**
|
|
8418
|
+
* Attaches event handler `fnFunction` to the {@link #event:fileAllowed fileAllowed} event of this `sap.ui.commons.FileUploader`.
|
|
8419
|
+
*
|
|
8420
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8421
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8422
|
+
*
|
|
8423
|
+
* Event is fired when the file is allowed for upload on client side.
|
|
8424
|
+
*
|
|
8425
|
+
*
|
|
8426
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8427
|
+
*/
|
|
8428
|
+
attachFileAllowed(
|
|
8429
|
+
/**
|
|
8430
|
+
* The function to be called when the event occurs
|
|
8431
|
+
*/
|
|
8432
|
+
fnFunction: (p1: Event) => void,
|
|
8433
|
+
/**
|
|
8434
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8435
|
+
*/
|
|
8436
|
+
oListener?: object
|
|
8437
|
+
): this;
|
|
8438
|
+
/**
|
|
8439
|
+
* Attaches event handler `fnFunction` to the {@link #event:fileEmpty fileEmpty} event of this `sap.ui.commons.FileUploader`.
|
|
8440
|
+
*
|
|
8441
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8442
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8443
|
+
*
|
|
8444
|
+
* Event is fired when the size of the file is 0
|
|
8445
|
+
*
|
|
8446
|
+
*
|
|
8447
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8448
|
+
*/
|
|
8449
|
+
attachFileEmpty(
|
|
8450
|
+
/**
|
|
8451
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
8452
|
+
* object when firing the event
|
|
8453
|
+
*/
|
|
8454
|
+
oData: object,
|
|
8455
|
+
/**
|
|
8456
|
+
* The function to be called when the event occurs
|
|
8457
|
+
*/
|
|
8458
|
+
fnFunction: (p1: FileUploader$FileEmptyEvent) => void,
|
|
8459
|
+
/**
|
|
8460
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8461
|
+
*/
|
|
8462
|
+
oListener?: object
|
|
8463
|
+
): this;
|
|
8464
|
+
/**
|
|
8465
|
+
* Attaches event handler `fnFunction` to the {@link #event:fileEmpty fileEmpty} event of this `sap.ui.commons.FileUploader`.
|
|
8466
|
+
*
|
|
8467
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8468
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8469
|
+
*
|
|
8470
|
+
* Event is fired when the size of the file is 0
|
|
8471
|
+
*
|
|
8472
|
+
*
|
|
8473
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8474
|
+
*/
|
|
8475
|
+
attachFileEmpty(
|
|
8476
|
+
/**
|
|
8477
|
+
* The function to be called when the event occurs
|
|
8478
|
+
*/
|
|
8479
|
+
fnFunction: (p1: FileUploader$FileEmptyEvent) => void,
|
|
8480
|
+
/**
|
|
8481
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8482
|
+
*/
|
|
8483
|
+
oListener?: object
|
|
8484
|
+
): this;
|
|
8485
|
+
/**
|
|
8486
|
+
* Attaches event handler `fnFunction` to the {@link #event:filenameLengthExceed filenameLengthExceed} event
|
|
8487
|
+
* of this `sap.ui.commons.FileUploader`.
|
|
8488
|
+
*
|
|
8489
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8490
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8491
|
+
*
|
|
8492
|
+
* Event is fired, if the filename of a chosen file is longer than the value specified with the `maximumFilenameLength`
|
|
8493
|
+
* property.
|
|
8494
|
+
*
|
|
8495
|
+
* @since 1.24.0
|
|
8496
|
+
*
|
|
8497
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8498
|
+
*/
|
|
8499
|
+
attachFilenameLengthExceed(
|
|
8500
|
+
/**
|
|
8501
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
8502
|
+
* object when firing the event
|
|
8503
|
+
*/
|
|
8504
|
+
oData: object,
|
|
8505
|
+
/**
|
|
8506
|
+
* The function to be called when the event occurs
|
|
8507
|
+
*/
|
|
8508
|
+
fnFunction: (p1: FileUploader$FilenameLengthExceedEvent) => void,
|
|
8509
|
+
/**
|
|
8510
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8511
|
+
*/
|
|
8512
|
+
oListener?: object
|
|
8513
|
+
): this;
|
|
8514
|
+
/**
|
|
8515
|
+
* Attaches event handler `fnFunction` to the {@link #event:filenameLengthExceed filenameLengthExceed} event
|
|
8516
|
+
* of this `sap.ui.commons.FileUploader`.
|
|
8517
|
+
*
|
|
8518
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8519
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8520
|
+
*
|
|
8521
|
+
* Event is fired, if the filename of a chosen file is longer than the value specified with the `maximumFilenameLength`
|
|
8522
|
+
* property.
|
|
8523
|
+
*
|
|
8524
|
+
* @since 1.24.0
|
|
8525
|
+
*
|
|
8526
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8527
|
+
*/
|
|
8528
|
+
attachFilenameLengthExceed(
|
|
8529
|
+
/**
|
|
8530
|
+
* The function to be called when the event occurs
|
|
8531
|
+
*/
|
|
8532
|
+
fnFunction: (p1: FileUploader$FilenameLengthExceedEvent) => void,
|
|
8533
|
+
/**
|
|
8534
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8535
|
+
*/
|
|
8536
|
+
oListener?: object
|
|
8537
|
+
): this;
|
|
8538
|
+
/**
|
|
8539
|
+
* Attaches event handler `fnFunction` to the {@link #event:fileSizeExceed fileSizeExceed} event of this
|
|
8540
|
+
* `sap.ui.commons.FileUploader`.
|
|
8541
|
+
*
|
|
8542
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8543
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8544
|
+
*
|
|
8545
|
+
* Event is fired when the size of a file is above the `maximumFileSize` property. This event is not supported
|
|
8546
|
+
* by Internet Explorer 9 (same restriction as for the property `maximumFileSize`).
|
|
8547
|
+
*
|
|
8548
|
+
*
|
|
8549
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8550
|
+
*/
|
|
8551
|
+
attachFileSizeExceed(
|
|
8552
|
+
/**
|
|
8553
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
8554
|
+
* object when firing the event
|
|
8555
|
+
*/
|
|
8556
|
+
oData: object,
|
|
8557
|
+
/**
|
|
8558
|
+
* The function to be called when the event occurs
|
|
8559
|
+
*/
|
|
8560
|
+
fnFunction: (p1: FileUploader$FileSizeExceedEvent) => void,
|
|
8561
|
+
/**
|
|
8562
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8563
|
+
*/
|
|
8564
|
+
oListener?: object
|
|
8565
|
+
): this;
|
|
8566
|
+
/**
|
|
8567
|
+
* Attaches event handler `fnFunction` to the {@link #event:fileSizeExceed fileSizeExceed} event of this
|
|
8568
|
+
* `sap.ui.commons.FileUploader`.
|
|
8569
|
+
*
|
|
8570
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8571
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8572
|
+
*
|
|
8573
|
+
* Event is fired when the size of a file is above the `maximumFileSize` property. This event is not supported
|
|
8574
|
+
* by Internet Explorer 9 (same restriction as for the property `maximumFileSize`).
|
|
8575
|
+
*
|
|
8576
|
+
*
|
|
8577
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8578
|
+
*/
|
|
8579
|
+
attachFileSizeExceed(
|
|
8580
|
+
/**
|
|
8581
|
+
* The function to be called when the event occurs
|
|
8582
|
+
*/
|
|
8583
|
+
fnFunction: (p1: FileUploader$FileSizeExceedEvent) => void,
|
|
8584
|
+
/**
|
|
8585
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8586
|
+
*/
|
|
8587
|
+
oListener?: object
|
|
8588
|
+
): this;
|
|
8589
|
+
/**
|
|
8590
|
+
* Attaches event handler `fnFunction` to the {@link #event:typeMissmatch typeMissmatch} event of this `sap.ui.commons.FileUploader`.
|
|
8591
|
+
*
|
|
8592
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8593
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8594
|
+
*
|
|
8595
|
+
* Event is fired when the type of a file does not match the `mimeType` or `fileType` property.
|
|
8596
|
+
*
|
|
8597
|
+
*
|
|
8598
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8599
|
+
*/
|
|
8600
|
+
attachTypeMissmatch(
|
|
8601
|
+
/**
|
|
8602
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
8603
|
+
* object when firing the event
|
|
8604
|
+
*/
|
|
8605
|
+
oData: object,
|
|
8606
|
+
/**
|
|
8607
|
+
* The function to be called when the event occurs
|
|
8608
|
+
*/
|
|
8609
|
+
fnFunction: (p1: FileUploader$TypeMissmatchEvent) => void,
|
|
8610
|
+
/**
|
|
8611
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8612
|
+
*/
|
|
8613
|
+
oListener?: object
|
|
8614
|
+
): this;
|
|
8615
|
+
/**
|
|
8616
|
+
* Attaches event handler `fnFunction` to the {@link #event:typeMissmatch typeMissmatch} event of this `sap.ui.commons.FileUploader`.
|
|
8617
|
+
*
|
|
8618
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8619
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8620
|
+
*
|
|
8621
|
+
* Event is fired when the type of a file does not match the `mimeType` or `fileType` property.
|
|
8622
|
+
*
|
|
8623
|
+
*
|
|
8624
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8625
|
+
*/
|
|
8626
|
+
attachTypeMissmatch(
|
|
8627
|
+
/**
|
|
8628
|
+
* The function to be called when the event occurs
|
|
8629
|
+
*/
|
|
8630
|
+
fnFunction: (p1: FileUploader$TypeMissmatchEvent) => void,
|
|
8631
|
+
/**
|
|
8632
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8633
|
+
*/
|
|
8634
|
+
oListener?: object
|
|
8635
|
+
): this;
|
|
8636
|
+
/**
|
|
8637
|
+
* Attaches event handler `fnFunction` to the {@link #event:uploadAborted uploadAborted} event of this `sap.ui.commons.FileUploader`.
|
|
8638
|
+
*
|
|
8639
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8640
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8641
|
+
*
|
|
8642
|
+
* Event is fired after the current upload has been aborted.
|
|
8643
|
+
*
|
|
8644
|
+
* This event is only supported with property `sendXHR` set to true, i.e. the event is not supported in
|
|
8645
|
+
* Internet Explorer 9.
|
|
8646
|
+
*
|
|
8647
|
+
* @since 1.24.0
|
|
8648
|
+
*
|
|
8649
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8650
|
+
*/
|
|
8651
|
+
attachUploadAborted(
|
|
8652
|
+
/**
|
|
8653
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
8654
|
+
* object when firing the event
|
|
8655
|
+
*/
|
|
8656
|
+
oData: object,
|
|
8657
|
+
/**
|
|
8658
|
+
* The function to be called when the event occurs
|
|
8659
|
+
*/
|
|
8660
|
+
fnFunction: (p1: FileUploader$UploadAbortedEvent) => void,
|
|
8661
|
+
/**
|
|
8662
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8663
|
+
*/
|
|
8664
|
+
oListener?: object
|
|
8665
|
+
): this;
|
|
8666
|
+
/**
|
|
8667
|
+
* Attaches event handler `fnFunction` to the {@link #event:uploadAborted uploadAborted} event of this `sap.ui.commons.FileUploader`.
|
|
8668
|
+
*
|
|
8669
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8670
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8671
|
+
*
|
|
8672
|
+
* Event is fired after the current upload has been aborted.
|
|
8673
|
+
*
|
|
8674
|
+
* This event is only supported with property `sendXHR` set to true, i.e. the event is not supported in
|
|
8675
|
+
* Internet Explorer 9.
|
|
8676
|
+
*
|
|
8677
|
+
* @since 1.24.0
|
|
8678
|
+
*
|
|
8679
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8680
|
+
*/
|
|
8681
|
+
attachUploadAborted(
|
|
8682
|
+
/**
|
|
8683
|
+
* The function to be called when the event occurs
|
|
8684
|
+
*/
|
|
8685
|
+
fnFunction: (p1: FileUploader$UploadAbortedEvent) => void,
|
|
8686
|
+
/**
|
|
8687
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8688
|
+
*/
|
|
8689
|
+
oListener?: object
|
|
8690
|
+
): this;
|
|
8691
|
+
/**
|
|
8692
|
+
* Attaches event handler `fnFunction` to the {@link #event:uploadComplete uploadComplete} event of this
|
|
8693
|
+
* `sap.ui.commons.FileUploader`.
|
|
8694
|
+
*
|
|
8695
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8696
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8697
|
+
*
|
|
8698
|
+
* Event is fired as soon as the upload request is completed (either successful or unsuccessful).
|
|
8699
|
+
*
|
|
8700
|
+
* To see if the upload request was successful, check the `status` parameter for a value 2xx. The actual
|
|
8701
|
+
* progress of the upload can be monitored by listening to the `uploadProgress` event. However, this covers
|
|
8702
|
+
* only the client side of the upload process and does not give any success status from the server.
|
|
8703
|
+
*
|
|
8704
|
+
*
|
|
8705
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8706
|
+
*/
|
|
8707
|
+
attachUploadComplete(
|
|
8708
|
+
/**
|
|
8709
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
8710
|
+
* object when firing the event
|
|
8711
|
+
*/
|
|
8712
|
+
oData: object,
|
|
8713
|
+
/**
|
|
8714
|
+
* The function to be called when the event occurs
|
|
8715
|
+
*/
|
|
8716
|
+
fnFunction: (p1: FileUploader$UploadCompleteEvent) => void,
|
|
8717
|
+
/**
|
|
8718
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8719
|
+
*/
|
|
8720
|
+
oListener?: object
|
|
8721
|
+
): this;
|
|
8722
|
+
/**
|
|
8723
|
+
* Attaches event handler `fnFunction` to the {@link #event:uploadComplete uploadComplete} event of this
|
|
8724
|
+
* `sap.ui.commons.FileUploader`.
|
|
8725
|
+
*
|
|
8726
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8727
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8728
|
+
*
|
|
8729
|
+
* Event is fired as soon as the upload request is completed (either successful or unsuccessful).
|
|
8730
|
+
*
|
|
8731
|
+
* To see if the upload request was successful, check the `status` parameter for a value 2xx. The actual
|
|
8732
|
+
* progress of the upload can be monitored by listening to the `uploadProgress` event. However, this covers
|
|
8733
|
+
* only the client side of the upload process and does not give any success status from the server.
|
|
8734
|
+
*
|
|
8735
|
+
*
|
|
8736
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8737
|
+
*/
|
|
8738
|
+
attachUploadComplete(
|
|
8739
|
+
/**
|
|
8740
|
+
* The function to be called when the event occurs
|
|
8741
|
+
*/
|
|
8742
|
+
fnFunction: (p1: FileUploader$UploadCompleteEvent) => void,
|
|
8743
|
+
/**
|
|
8744
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8745
|
+
*/
|
|
8746
|
+
oListener?: object
|
|
8747
|
+
): this;
|
|
8748
|
+
/**
|
|
8749
|
+
* Attaches event handler `fnFunction` to the {@link #event:uploadProgress uploadProgress} event of this
|
|
8750
|
+
* `sap.ui.commons.FileUploader`.
|
|
8751
|
+
*
|
|
8752
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8753
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8754
|
+
*
|
|
8755
|
+
* Event is fired after the upload has started and before the upload is completed.
|
|
8756
|
+
*
|
|
8757
|
+
* It contains progress information related to the running upload. Depending on file size, band width and
|
|
8758
|
+
* used browser the event is fired once or multiple times.
|
|
8759
|
+
*
|
|
8760
|
+
* This event is only supported with property `sendXHR` set to true, i.e. the event is not supported in
|
|
8761
|
+
* Internet Explorer 9.
|
|
8762
|
+
*
|
|
8763
|
+
* @since 1.24.0
|
|
8764
|
+
*
|
|
8765
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8766
|
+
*/
|
|
8767
|
+
attachUploadProgress(
|
|
8768
|
+
/**
|
|
8769
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
8770
|
+
* object when firing the event
|
|
8771
|
+
*/
|
|
8772
|
+
oData: object,
|
|
8773
|
+
/**
|
|
8774
|
+
* The function to be called when the event occurs
|
|
8775
|
+
*/
|
|
8776
|
+
fnFunction: (p1: FileUploader$UploadProgressEvent) => void,
|
|
8777
|
+
/**
|
|
8778
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8779
|
+
*/
|
|
8780
|
+
oListener?: object
|
|
8781
|
+
): this;
|
|
8782
|
+
/**
|
|
8783
|
+
* Attaches event handler `fnFunction` to the {@link #event:uploadProgress uploadProgress} event of this
|
|
8784
|
+
* `sap.ui.commons.FileUploader`.
|
|
8785
|
+
*
|
|
8786
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8787
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8788
|
+
*
|
|
8789
|
+
* Event is fired after the upload has started and before the upload is completed.
|
|
8790
|
+
*
|
|
8791
|
+
* It contains progress information related to the running upload. Depending on file size, band width and
|
|
8792
|
+
* used browser the event is fired once or multiple times.
|
|
8793
|
+
*
|
|
8794
|
+
* This event is only supported with property `sendXHR` set to true, i.e. the event is not supported in
|
|
8795
|
+
* Internet Explorer 9.
|
|
8796
|
+
*
|
|
8797
|
+
* @since 1.24.0
|
|
8798
|
+
*
|
|
8799
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8800
|
+
*/
|
|
8801
|
+
attachUploadProgress(
|
|
8802
|
+
/**
|
|
8803
|
+
* The function to be called when the event occurs
|
|
8804
|
+
*/
|
|
8805
|
+
fnFunction: (p1: FileUploader$UploadProgressEvent) => void,
|
|
8806
|
+
/**
|
|
8807
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8808
|
+
*/
|
|
8809
|
+
oListener?: object
|
|
8810
|
+
): this;
|
|
8811
|
+
/**
|
|
8812
|
+
* Attaches event handler `fnFunction` to the {@link #event:uploadStart uploadStart} event of this `sap.ui.commons.FileUploader`.
|
|
8813
|
+
*
|
|
8814
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8815
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8816
|
+
*
|
|
8817
|
+
* Event is fired before an upload is started.
|
|
8818
|
+
*
|
|
8819
|
+
* @since 1.30.0
|
|
8820
|
+
*
|
|
8821
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8822
|
+
*/
|
|
8823
|
+
attachUploadStart(
|
|
8824
|
+
/**
|
|
8825
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
8826
|
+
* object when firing the event
|
|
8827
|
+
*/
|
|
8828
|
+
oData: object,
|
|
8829
|
+
/**
|
|
8830
|
+
* The function to be called when the event occurs
|
|
8831
|
+
*/
|
|
8832
|
+
fnFunction: (p1: FileUploader$UploadStartEvent) => void,
|
|
8833
|
+
/**
|
|
8834
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8835
|
+
*/
|
|
8836
|
+
oListener?: object
|
|
8837
|
+
): this;
|
|
8838
|
+
/**
|
|
8839
|
+
* Attaches event handler `fnFunction` to the {@link #event:uploadStart uploadStart} event of this `sap.ui.commons.FileUploader`.
|
|
8840
|
+
*
|
|
8841
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
8842
|
+
* otherwise it will be bound to this `sap.ui.commons.FileUploader` itself.
|
|
8843
|
+
*
|
|
8844
|
+
* Event is fired before an upload is started.
|
|
8845
|
+
*
|
|
8846
|
+
* @since 1.30.0
|
|
8847
|
+
*
|
|
8848
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8849
|
+
*/
|
|
8850
|
+
attachUploadStart(
|
|
8851
|
+
/**
|
|
8852
|
+
* The function to be called when the event occurs
|
|
8853
|
+
*/
|
|
8854
|
+
fnFunction: (p1: FileUploader$UploadStartEvent) => void,
|
|
8855
|
+
/**
|
|
8856
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself
|
|
8857
|
+
*/
|
|
8858
|
+
oListener?: object
|
|
8859
|
+
): this;
|
|
8860
|
+
/**
|
|
8861
|
+
* Checks if the chosen file is readable.
|
|
8862
|
+
*
|
|
8863
|
+
*
|
|
8864
|
+
* @returns A promise that resolves successfully if the chosen file can be read and fails with an error
|
|
8865
|
+
* message if it cannot
|
|
8866
|
+
*/
|
|
8867
|
+
checkFileReadable(): Promise<any>;
|
|
8868
|
+
/**
|
|
8869
|
+
* Clears the content of the `FileUploader`.
|
|
8870
|
+
*
|
|
8871
|
+
* **Note:** The attached additional data however is retained.
|
|
8872
|
+
*
|
|
8873
|
+
* @since 1.25.0
|
|
8874
|
+
*
|
|
8875
|
+
* @returns Reference to `this` for method chaining
|
|
8876
|
+
*/
|
|
8877
|
+
clear(): this;
|
|
8878
|
+
/**
|
|
8879
|
+
* Destroys all the headerParameters in the aggregation {@link #getHeaderParameters headerParameters}.
|
|
8880
|
+
*
|
|
8881
|
+
*
|
|
8882
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8883
|
+
*/
|
|
8884
|
+
destroyHeaderParameters(): this;
|
|
8885
|
+
/**
|
|
8886
|
+
* Destroys all the parameters in the aggregation {@link #getParameters parameters}.
|
|
8887
|
+
*
|
|
8888
|
+
* @since 1.12.2
|
|
8889
|
+
*
|
|
8890
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8891
|
+
*/
|
|
8892
|
+
destroyParameters(): this;
|
|
8893
|
+
/**
|
|
8894
|
+
* Destroys the xhrSettings in the aggregation {@link #getXhrSettings xhrSettings}.
|
|
8895
|
+
*
|
|
8896
|
+
* @since 1.52
|
|
8897
|
+
*
|
|
8898
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8899
|
+
*/
|
|
8900
|
+
destroyXhrSettings(): this;
|
|
8901
|
+
/**
|
|
8902
|
+
* Detaches event handler `fnFunction` from the {@link #event:afterDialogClose afterDialogClose} event of
|
|
8903
|
+
* this `sap.ui.commons.FileUploader`.
|
|
8904
|
+
*
|
|
8905
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
8906
|
+
*
|
|
8907
|
+
* @since 1.102.0
|
|
8908
|
+
*
|
|
8909
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8910
|
+
*/
|
|
8911
|
+
detachAfterDialogClose(
|
|
8912
|
+
/**
|
|
8913
|
+
* The function to be called, when the event occurs
|
|
8914
|
+
*/
|
|
8915
|
+
fnFunction: (p1: Event) => void,
|
|
8916
|
+
/**
|
|
8917
|
+
* Context object on which the given function had to be called
|
|
8918
|
+
*/
|
|
8919
|
+
oListener?: object
|
|
8920
|
+
): this;
|
|
8921
|
+
/**
|
|
8922
|
+
* Detaches event handler `fnFunction` from the {@link #event:beforeDialogOpen beforeDialogOpen} event of
|
|
8923
|
+
* this `sap.ui.commons.FileUploader`.
|
|
8924
|
+
*
|
|
8925
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
8926
|
+
*
|
|
8927
|
+
* @since 1.102.0
|
|
8928
|
+
*
|
|
8929
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8930
|
+
*/
|
|
8931
|
+
detachBeforeDialogOpen(
|
|
8932
|
+
/**
|
|
8933
|
+
* The function to be called, when the event occurs
|
|
8934
|
+
*/
|
|
8935
|
+
fnFunction: (p1: Event) => void,
|
|
8936
|
+
/**
|
|
8937
|
+
* Context object on which the given function had to be called
|
|
8938
|
+
*/
|
|
8939
|
+
oListener?: object
|
|
8940
|
+
): this;
|
|
8941
|
+
/**
|
|
8942
|
+
* Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.commons.FileUploader`.
|
|
8943
|
+
*
|
|
8944
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
8945
|
+
*
|
|
8946
|
+
*
|
|
8947
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8948
|
+
*/
|
|
8949
|
+
detachChange(
|
|
8950
|
+
/**
|
|
8951
|
+
* The function to be called, when the event occurs
|
|
8952
|
+
*/
|
|
8953
|
+
fnFunction: (p1: FileUploader$ChangeEvent) => void,
|
|
8954
|
+
/**
|
|
8955
|
+
* Context object on which the given function had to be called
|
|
8956
|
+
*/
|
|
8957
|
+
oListener?: object
|
|
8958
|
+
): this;
|
|
8959
|
+
/**
|
|
8960
|
+
* Detaches event handler `fnFunction` from the {@link #event:fileAllowed fileAllowed} event of this `sap.ui.commons.FileUploader`.
|
|
8961
|
+
*
|
|
8962
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
8963
|
+
*
|
|
8964
|
+
*
|
|
8965
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8966
|
+
*/
|
|
8967
|
+
detachFileAllowed(
|
|
8968
|
+
/**
|
|
8969
|
+
* The function to be called, when the event occurs
|
|
8970
|
+
*/
|
|
8971
|
+
fnFunction: (p1: Event) => void,
|
|
8972
|
+
/**
|
|
8973
|
+
* Context object on which the given function had to be called
|
|
8974
|
+
*/
|
|
8975
|
+
oListener?: object
|
|
8976
|
+
): this;
|
|
8977
|
+
/**
|
|
8978
|
+
* Detaches event handler `fnFunction` from the {@link #event:fileEmpty fileEmpty} event of this `sap.ui.commons.FileUploader`.
|
|
8979
|
+
*
|
|
8980
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
8981
|
+
*
|
|
8982
|
+
*
|
|
8983
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
8984
|
+
*/
|
|
8985
|
+
detachFileEmpty(
|
|
8986
|
+
/**
|
|
8987
|
+
* The function to be called, when the event occurs
|
|
8988
|
+
*/
|
|
8989
|
+
fnFunction: (p1: FileUploader$FileEmptyEvent) => void,
|
|
8990
|
+
/**
|
|
8991
|
+
* Context object on which the given function had to be called
|
|
8992
|
+
*/
|
|
8993
|
+
oListener?: object
|
|
8994
|
+
): this;
|
|
8995
|
+
/**
|
|
8996
|
+
* Detaches event handler `fnFunction` from the {@link #event:filenameLengthExceed filenameLengthExceed }
|
|
8997
|
+
* event of this `sap.ui.commons.FileUploader`.
|
|
8998
|
+
*
|
|
8999
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
9000
|
+
*
|
|
9001
|
+
* @since 1.24.0
|
|
9002
|
+
*
|
|
9003
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9004
|
+
*/
|
|
9005
|
+
detachFilenameLengthExceed(
|
|
9006
|
+
/**
|
|
9007
|
+
* The function to be called, when the event occurs
|
|
9008
|
+
*/
|
|
9009
|
+
fnFunction: (p1: FileUploader$FilenameLengthExceedEvent) => void,
|
|
9010
|
+
/**
|
|
9011
|
+
* Context object on which the given function had to be called
|
|
9012
|
+
*/
|
|
9013
|
+
oListener?: object
|
|
9014
|
+
): this;
|
|
9015
|
+
/**
|
|
9016
|
+
* Detaches event handler `fnFunction` from the {@link #event:fileSizeExceed fileSizeExceed} event of this
|
|
9017
|
+
* `sap.ui.commons.FileUploader`.
|
|
9018
|
+
*
|
|
9019
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
9020
|
+
*
|
|
9021
|
+
*
|
|
9022
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9023
|
+
*/
|
|
9024
|
+
detachFileSizeExceed(
|
|
9025
|
+
/**
|
|
9026
|
+
* The function to be called, when the event occurs
|
|
9027
|
+
*/
|
|
9028
|
+
fnFunction: (p1: FileUploader$FileSizeExceedEvent) => void,
|
|
9029
|
+
/**
|
|
9030
|
+
* Context object on which the given function had to be called
|
|
9031
|
+
*/
|
|
9032
|
+
oListener?: object
|
|
9033
|
+
): this;
|
|
9034
|
+
/**
|
|
9035
|
+
* Detaches event handler `fnFunction` from the {@link #event:typeMissmatch typeMissmatch} event of this
|
|
9036
|
+
* `sap.ui.commons.FileUploader`.
|
|
9037
|
+
*
|
|
9038
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
9039
|
+
*
|
|
9040
|
+
*
|
|
9041
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9042
|
+
*/
|
|
9043
|
+
detachTypeMissmatch(
|
|
9044
|
+
/**
|
|
9045
|
+
* The function to be called, when the event occurs
|
|
9046
|
+
*/
|
|
9047
|
+
fnFunction: (p1: FileUploader$TypeMissmatchEvent) => void,
|
|
9048
|
+
/**
|
|
9049
|
+
* Context object on which the given function had to be called
|
|
9050
|
+
*/
|
|
9051
|
+
oListener?: object
|
|
9052
|
+
): this;
|
|
9053
|
+
/**
|
|
9054
|
+
* Detaches event handler `fnFunction` from the {@link #event:uploadAborted uploadAborted} event of this
|
|
9055
|
+
* `sap.ui.commons.FileUploader`.
|
|
9056
|
+
*
|
|
9057
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
9058
|
+
*
|
|
9059
|
+
* @since 1.24.0
|
|
9060
|
+
*
|
|
9061
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9062
|
+
*/
|
|
9063
|
+
detachUploadAborted(
|
|
9064
|
+
/**
|
|
9065
|
+
* The function to be called, when the event occurs
|
|
9066
|
+
*/
|
|
9067
|
+
fnFunction: (p1: FileUploader$UploadAbortedEvent) => void,
|
|
9068
|
+
/**
|
|
9069
|
+
* Context object on which the given function had to be called
|
|
9070
|
+
*/
|
|
9071
|
+
oListener?: object
|
|
9072
|
+
): this;
|
|
9073
|
+
/**
|
|
9074
|
+
* Detaches event handler `fnFunction` from the {@link #event:uploadComplete uploadComplete} event of this
|
|
9075
|
+
* `sap.ui.commons.FileUploader`.
|
|
9076
|
+
*
|
|
9077
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
9078
|
+
*
|
|
9079
|
+
*
|
|
9080
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9081
|
+
*/
|
|
9082
|
+
detachUploadComplete(
|
|
9083
|
+
/**
|
|
9084
|
+
* The function to be called, when the event occurs
|
|
9085
|
+
*/
|
|
9086
|
+
fnFunction: (p1: FileUploader$UploadCompleteEvent) => void,
|
|
9087
|
+
/**
|
|
9088
|
+
* Context object on which the given function had to be called
|
|
9089
|
+
*/
|
|
9090
|
+
oListener?: object
|
|
9091
|
+
): this;
|
|
9092
|
+
/**
|
|
9093
|
+
* Detaches event handler `fnFunction` from the {@link #event:uploadProgress uploadProgress} event of this
|
|
9094
|
+
* `sap.ui.commons.FileUploader`.
|
|
9095
|
+
*
|
|
9096
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
9097
|
+
*
|
|
9098
|
+
* @since 1.24.0
|
|
9099
|
+
*
|
|
9100
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9101
|
+
*/
|
|
9102
|
+
detachUploadProgress(
|
|
9103
|
+
/**
|
|
9104
|
+
* The function to be called, when the event occurs
|
|
9105
|
+
*/
|
|
9106
|
+
fnFunction: (p1: FileUploader$UploadProgressEvent) => void,
|
|
9107
|
+
/**
|
|
9108
|
+
* Context object on which the given function had to be called
|
|
9109
|
+
*/
|
|
9110
|
+
oListener?: object
|
|
9111
|
+
): this;
|
|
9112
|
+
/**
|
|
9113
|
+
* Detaches event handler `fnFunction` from the {@link #event:uploadStart uploadStart} event of this `sap.ui.commons.FileUploader`.
|
|
9114
|
+
*
|
|
9115
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
9116
|
+
*
|
|
9117
|
+
* @since 1.30.0
|
|
9118
|
+
*
|
|
9119
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9120
|
+
*/
|
|
9121
|
+
detachUploadStart(
|
|
9122
|
+
/**
|
|
9123
|
+
* The function to be called, when the event occurs
|
|
9124
|
+
*/
|
|
9125
|
+
fnFunction: (p1: FileUploader$UploadStartEvent) => void,
|
|
9126
|
+
/**
|
|
9127
|
+
* Context object on which the given function had to be called
|
|
9128
|
+
*/
|
|
9129
|
+
oListener?: object
|
|
9130
|
+
): this;
|
|
9131
|
+
/**
|
|
9132
|
+
* Fires event {@link #event:afterDialogClose afterDialogClose} to attached listeners.
|
|
9133
|
+
*
|
|
9134
|
+
* @since 1.102.0
|
|
9135
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
9136
|
+
*
|
|
9137
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9138
|
+
*/
|
|
9139
|
+
fireAfterDialogClose(
|
|
9140
|
+
/**
|
|
9141
|
+
* Parameters to pass along with the event
|
|
9142
|
+
*/
|
|
9143
|
+
mParameters?: object
|
|
9144
|
+
): this;
|
|
9145
|
+
/**
|
|
9146
|
+
* Fires event {@link #event:beforeDialogOpen beforeDialogOpen} to attached listeners.
|
|
9147
|
+
*
|
|
9148
|
+
* @since 1.102.0
|
|
9149
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
9150
|
+
*
|
|
9151
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9152
|
+
*/
|
|
9153
|
+
fireBeforeDialogOpen(
|
|
9154
|
+
/**
|
|
9155
|
+
* Parameters to pass along with the event
|
|
9156
|
+
*/
|
|
9157
|
+
mParameters?: object
|
|
9158
|
+
): this;
|
|
9159
|
+
/**
|
|
9160
|
+
* Fires event {@link #event:change change} to attached listeners.
|
|
9161
|
+
*
|
|
9162
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
9163
|
+
*
|
|
9164
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9165
|
+
*/
|
|
9166
|
+
fireChange(
|
|
9167
|
+
/**
|
|
9168
|
+
* Parameters to pass along with the event
|
|
9169
|
+
*/
|
|
9170
|
+
mParameters?: FileUploader$ChangeEventParameters
|
|
9171
|
+
): this;
|
|
9172
|
+
/**
|
|
9173
|
+
* Fires event {@link #event:fileAllowed fileAllowed} to attached listeners.
|
|
9174
|
+
*
|
|
9175
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
9176
|
+
*
|
|
9177
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9178
|
+
*/
|
|
9179
|
+
fireFileAllowed(
|
|
9180
|
+
/**
|
|
9181
|
+
* Parameters to pass along with the event
|
|
9182
|
+
*/
|
|
9183
|
+
mParameters?: object
|
|
9184
|
+
): this;
|
|
9185
|
+
/**
|
|
9186
|
+
* Fires event {@link #event:fileEmpty fileEmpty} to attached listeners.
|
|
9187
|
+
*
|
|
9188
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
9189
|
+
*
|
|
9190
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9191
|
+
*/
|
|
9192
|
+
fireFileEmpty(
|
|
9193
|
+
/**
|
|
9194
|
+
* Parameters to pass along with the event
|
|
9195
|
+
*/
|
|
9196
|
+
mParameters?: FileUploader$FileEmptyEventParameters
|
|
9197
|
+
): this;
|
|
9198
|
+
/**
|
|
9199
|
+
* Fires event {@link #event:filenameLengthExceed filenameLengthExceed} to attached listeners.
|
|
9200
|
+
*
|
|
9201
|
+
* @since 1.24.0
|
|
9202
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
9203
|
+
*
|
|
9204
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9205
|
+
*/
|
|
9206
|
+
fireFilenameLengthExceed(
|
|
9207
|
+
/**
|
|
9208
|
+
* Parameters to pass along with the event
|
|
9209
|
+
*/
|
|
9210
|
+
mParameters?: FileUploader$FilenameLengthExceedEventParameters
|
|
9211
|
+
): this;
|
|
9212
|
+
/**
|
|
9213
|
+
* Fires event {@link #event:fileSizeExceed fileSizeExceed} to attached listeners.
|
|
9214
|
+
*
|
|
9215
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
9216
|
+
*
|
|
9217
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9218
|
+
*/
|
|
9219
|
+
fireFileSizeExceed(
|
|
9220
|
+
/**
|
|
9221
|
+
* Parameters to pass along with the event
|
|
9222
|
+
*/
|
|
9223
|
+
mParameters?: FileUploader$FileSizeExceedEventParameters
|
|
9224
|
+
): this;
|
|
9225
|
+
/**
|
|
9226
|
+
* Fires event {@link #event:typeMissmatch typeMissmatch} to attached listeners.
|
|
9227
|
+
*
|
|
9228
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
9229
|
+
*
|
|
9230
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9231
|
+
*/
|
|
9232
|
+
fireTypeMissmatch(
|
|
9233
|
+
/**
|
|
9234
|
+
* Parameters to pass along with the event
|
|
9235
|
+
*/
|
|
9236
|
+
mParameters?: FileUploader$TypeMissmatchEventParameters
|
|
9237
|
+
): this;
|
|
9238
|
+
/**
|
|
9239
|
+
* Fires event {@link #event:uploadAborted uploadAborted} to attached listeners.
|
|
9240
|
+
*
|
|
9241
|
+
* @since 1.24.0
|
|
9242
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
9243
|
+
*
|
|
9244
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9245
|
+
*/
|
|
9246
|
+
fireUploadAborted(
|
|
9247
|
+
/**
|
|
9248
|
+
* Parameters to pass along with the event
|
|
9249
|
+
*/
|
|
9250
|
+
mParameters?: FileUploader$UploadAbortedEventParameters
|
|
9251
|
+
): this;
|
|
9252
|
+
/**
|
|
9253
|
+
* Fires event {@link #event:uploadComplete uploadComplete} to attached listeners.
|
|
9254
|
+
*
|
|
9255
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
9256
|
+
*
|
|
9257
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9258
|
+
*/
|
|
9259
|
+
fireUploadComplete(
|
|
9260
|
+
/**
|
|
9261
|
+
* Parameters to pass along with the event
|
|
9262
|
+
*/
|
|
9263
|
+
mParameters?: FileUploader$UploadCompleteEventParameters
|
|
9264
|
+
): this;
|
|
9265
|
+
/**
|
|
9266
|
+
* Fires event {@link #event:uploadProgress uploadProgress} to attached listeners.
|
|
9267
|
+
*
|
|
9268
|
+
* @since 1.24.0
|
|
9269
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
9270
|
+
*
|
|
9271
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9272
|
+
*/
|
|
9273
|
+
fireUploadProgress(
|
|
9274
|
+
/**
|
|
9275
|
+
* Parameters to pass along with the event
|
|
9276
|
+
*/
|
|
9277
|
+
mParameters?: FileUploader$UploadProgressEventParameters
|
|
9278
|
+
): this;
|
|
9279
|
+
/**
|
|
9280
|
+
* Fires event {@link #event:uploadStart uploadStart} to attached listeners.
|
|
9281
|
+
*
|
|
9282
|
+
* @since 1.30.0
|
|
9283
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
9284
|
+
*
|
|
9285
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9286
|
+
*/
|
|
9287
|
+
fireUploadStart(
|
|
9288
|
+
/**
|
|
9289
|
+
* Parameters to pass along with the event
|
|
9290
|
+
*/
|
|
9291
|
+
mParameters?: FileUploader$UploadStartEventParameters
|
|
9292
|
+
): this;
|
|
9293
|
+
/**
|
|
9294
|
+
* Gets current value of property {@link #getAdditionalData additionalData}.
|
|
9295
|
+
*
|
|
9296
|
+
* Additional data that is sent to the back end service.
|
|
9297
|
+
*
|
|
9298
|
+
* Data will be transmitted as value of a hidden input where the name is derived from the `name` property
|
|
9299
|
+
* with suffix "-data".
|
|
9300
|
+
*
|
|
9301
|
+
*
|
|
9302
|
+
* @returns Value of property `additionalData`
|
|
9303
|
+
*/
|
|
9304
|
+
getAdditionalData(): string;
|
|
9305
|
+
/**
|
|
9306
|
+
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
|
|
9307
|
+
*/
|
|
9308
|
+
getAriaDescribedBy(): ID[];
|
|
9309
|
+
/**
|
|
9310
|
+
* Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
|
|
9311
|
+
*/
|
|
9312
|
+
getAriaLabelledBy(): ID[];
|
|
9313
|
+
/**
|
|
9314
|
+
* Gets current value of property {@link #getButtonOnly buttonOnly}.
|
|
9315
|
+
*
|
|
9316
|
+
* If set to "true", the `FileUploader` will be rendered as Button only, without showing the input field.
|
|
9317
|
+
*
|
|
9318
|
+
* Default value is `false`.
|
|
9319
|
+
*
|
|
9320
|
+
*
|
|
9321
|
+
* @returns Value of property `buttonOnly`
|
|
9322
|
+
*/
|
|
9323
|
+
getButtonOnly(): boolean;
|
|
9324
|
+
/**
|
|
9325
|
+
* Gets current value of property {@link #getButtonText buttonText}.
|
|
9326
|
+
*
|
|
9327
|
+
* The button's text can be overwritten using this property.
|
|
9328
|
+
*
|
|
9329
|
+
*
|
|
9330
|
+
* @returns Value of property `buttonText`
|
|
9331
|
+
*/
|
|
9332
|
+
getButtonText(): string;
|
|
9333
|
+
/**
|
|
9334
|
+
* Gets current value of property {@link #getDirectory directory}.
|
|
9335
|
+
*
|
|
9336
|
+
* Allows users to upload all files from a given directory and its corresponding subdirectories.
|
|
9337
|
+
*
|
|
9338
|
+
* Default value is `false`.
|
|
9339
|
+
*
|
|
9340
|
+
* @since 1.105.0
|
|
9341
|
+
*
|
|
9342
|
+
* @returns Value of property `directory`
|
|
9343
|
+
*/
|
|
9344
|
+
getDirectory(): boolean;
|
|
9345
|
+
/**
|
|
9346
|
+
* Gets current value of property {@link #getEnabled enabled}.
|
|
9347
|
+
*
|
|
9348
|
+
* Disabled controls have different colors, depending on customer settings.
|
|
9349
|
+
*
|
|
9350
|
+
* Default value is `true`.
|
|
9351
|
+
*
|
|
9352
|
+
*
|
|
9353
|
+
* @returns Value of property `enabled`
|
|
9354
|
+
*/
|
|
9355
|
+
getEnabled(): boolean;
|
|
9356
|
+
/**
|
|
9357
|
+
* Gets current value of property {@link #getFileType fileType}.
|
|
9358
|
+
*
|
|
9359
|
+
* The chosen files will be checked against an array of file types.
|
|
9360
|
+
*
|
|
9361
|
+
* If at least one file does not fit the file type restriction, the upload is prevented. **Note:** This
|
|
9362
|
+
* property is not supported by Microsoft Edge.
|
|
9363
|
+
*
|
|
9364
|
+
* Example: `["jpg", "png", "bmp"]`.
|
|
9365
|
+
*
|
|
9366
|
+
*
|
|
9367
|
+
* @returns Value of property `fileType`
|
|
9368
|
+
*/
|
|
9369
|
+
getFileType(): string[];
|
|
9370
|
+
/**
|
|
9371
|
+
* Gets content of aggregation {@link #getHeaderParameters headerParameters}.
|
|
9372
|
+
*
|
|
9373
|
+
* The header parameters for the `FileUploader` which are only submitted with XHR requests. Header parameters
|
|
9374
|
+
* are not supported by Internet Explorer 9.
|
|
9375
|
+
*/
|
|
9376
|
+
getHeaderParameters(): FileUploaderParameter[];
|
|
9377
|
+
/**
|
|
9378
|
+
* Gets current value of property {@link #getHttpRequestMethod httpRequestMethod}.
|
|
9379
|
+
*
|
|
9380
|
+
* Chosen HTTP request method for file upload.
|
|
9381
|
+
*
|
|
9382
|
+
* Default value is `Post`.
|
|
9383
|
+
*
|
|
9384
|
+
* @since 1.81.0
|
|
9385
|
+
*
|
|
9386
|
+
* @returns Value of property `httpRequestMethod`
|
|
9387
|
+
*/
|
|
9388
|
+
getHttpRequestMethod(): FileUploaderHttpRequestMethod;
|
|
9389
|
+
/**
|
|
9390
|
+
* Gets current value of property {@link #getIcon icon}.
|
|
9391
|
+
*
|
|
9392
|
+
* Icon to be displayed as graphical element within the button.
|
|
9393
|
+
*
|
|
9394
|
+
* This can be a URI to an image or an icon font URI.
|
|
9395
|
+
*
|
|
9396
|
+
* Default value is `empty string`.
|
|
9397
|
+
*
|
|
9398
|
+
* @since 1.26.0
|
|
9399
|
+
*
|
|
9400
|
+
* @returns Value of property `icon`
|
|
9401
|
+
*/
|
|
9402
|
+
getIcon(): URI;
|
|
9403
|
+
/**
|
|
9404
|
+
* Gets current value of property {@link #getIconFirst iconFirst}.
|
|
9405
|
+
*
|
|
9406
|
+
* If set to true (default), the display sequence is 1. icon 2. control text.
|
|
9407
|
+
*
|
|
9408
|
+
* Default value is `true`.
|
|
9409
|
+
*
|
|
9410
|
+
* @since 1.26.0
|
|
9411
|
+
*
|
|
9412
|
+
* @returns Value of property `iconFirst`
|
|
9413
|
+
*/
|
|
9414
|
+
getIconFirst(): boolean;
|
|
9415
|
+
/**
|
|
9416
|
+
* Gets current value of property {@link #getIconHovered iconHovered}.
|
|
9417
|
+
*
|
|
9418
|
+
* Icon to be displayed as graphical element within the button when it is hovered (only if also a base icon
|
|
9419
|
+
* was specified).
|
|
9420
|
+
*
|
|
9421
|
+
* If not specified, the base icon is used. If an icon font icon is used, this property is ignored.
|
|
9422
|
+
*
|
|
9423
|
+
* Default value is `empty string`.
|
|
9424
|
+
*
|
|
9425
|
+
* @since 1.26.0
|
|
9426
|
+
*
|
|
9427
|
+
* @returns Value of property `iconHovered`
|
|
9428
|
+
*/
|
|
9429
|
+
getIconHovered(): URI;
|
|
9430
|
+
/**
|
|
9431
|
+
* Gets current value of property {@link #getIconOnly iconOnly}.
|
|
9432
|
+
*
|
|
9433
|
+
* If set to true, the button is displayed without any text.
|
|
9434
|
+
*
|
|
9435
|
+
* Default value is `false`.
|
|
9436
|
+
*
|
|
9437
|
+
* @since 1.26.0
|
|
9438
|
+
*
|
|
9439
|
+
* @returns Value of property `iconOnly`
|
|
9440
|
+
*/
|
|
9441
|
+
getIconOnly(): boolean;
|
|
9442
|
+
/**
|
|
9443
|
+
* Gets current value of property {@link #getIconSelected iconSelected}.
|
|
9444
|
+
*
|
|
9445
|
+
* Icon to be displayed as graphical element within the button when it is selected (only if also a base
|
|
9446
|
+
* icon was specified).
|
|
9447
|
+
*
|
|
9448
|
+
* If not specified, the base or hovered icon is used. If an icon font icon is used, this property is ignored.
|
|
9449
|
+
*
|
|
9450
|
+
* Default value is `empty string`.
|
|
9451
|
+
*
|
|
9452
|
+
* @since 1.26.0
|
|
9453
|
+
*
|
|
9454
|
+
* @returns Value of property `iconSelected`
|
|
9455
|
+
*/
|
|
9456
|
+
getIconSelected(): URI;
|
|
9457
|
+
/**
|
|
9458
|
+
* Gets current value of property {@link #getMaximumFilenameLength maximumFilenameLength}.
|
|
9459
|
+
*
|
|
9460
|
+
* The maximum length of a filename which the `FileUploader` will accept.
|
|
9461
|
+
*
|
|
9462
|
+
* If the maximum filename length is exceeded, the corresponding event `filenameLengthExceed` is fired.
|
|
9463
|
+
*
|
|
9464
|
+
* @since 1.24.0
|
|
9465
|
+
*
|
|
9466
|
+
* @returns Value of property `maximumFilenameLength`
|
|
9467
|
+
*/
|
|
9468
|
+
getMaximumFilenameLength(): int;
|
|
9469
|
+
/**
|
|
9470
|
+
* Gets current value of property {@link #getMaximumFileSize maximumFileSize}.
|
|
9471
|
+
*
|
|
9472
|
+
* A file size limit in megabytes which prevents the upload if at least one file exceeds it.
|
|
9473
|
+
*
|
|
9474
|
+
* This property is not supported by Internet Explorer 9.
|
|
9475
|
+
*
|
|
9476
|
+
*
|
|
9477
|
+
* @returns Value of property `maximumFileSize`
|
|
9478
|
+
*/
|
|
9479
|
+
getMaximumFileSize(): float;
|
|
9480
|
+
/**
|
|
9481
|
+
* Gets current value of property {@link #getMimeType mimeType}.
|
|
9482
|
+
*
|
|
9483
|
+
* The chosen files will be checked against an array of MIME types defined in this property.
|
|
9484
|
+
*
|
|
9485
|
+
* If at least one file does not fit the MIME type restriction, the upload is prevented.
|
|
9486
|
+
*
|
|
9487
|
+
* **Note:** This property is not supported by Internet Explorer. It is only reliable for common file types
|
|
9488
|
+
* like images, audio, video, plain text and HTML documents. File types that are not recognized by the browser
|
|
9489
|
+
* result in `file.type` to be returned as an empty string. In this case the verification could not be performed.
|
|
9490
|
+
* The file upload is not prevented and the validation based on file type is left to the receiving backend
|
|
9491
|
+
* side.
|
|
9492
|
+
*
|
|
9493
|
+
* Example: `["image/png", "image/jpeg"]`.
|
|
9494
|
+
*
|
|
9495
|
+
*
|
|
9496
|
+
* @returns Value of property `mimeType`
|
|
9497
|
+
*/
|
|
9498
|
+
getMimeType(): string[];
|
|
9499
|
+
/**
|
|
9500
|
+
* Gets current value of property {@link #getMultiple multiple}.
|
|
9501
|
+
*
|
|
9502
|
+
* Allows multiple files to be chosen and uploaded from the same folder.
|
|
9503
|
+
*
|
|
9504
|
+
* This property is not supported by Internet Explorer 9.
|
|
9505
|
+
*
|
|
9506
|
+
* **Note:** Keep in mind that the various operating systems for mobile devices can react differently to
|
|
9507
|
+
* the property so that fewer upload functions may be available in some cases.
|
|
9508
|
+
*
|
|
9509
|
+
* Default value is `false`.
|
|
9510
|
+
*
|
|
9511
|
+
*
|
|
9512
|
+
* @returns Value of property `multiple`
|
|
9513
|
+
*/
|
|
9514
|
+
getMultiple(): boolean;
|
|
9515
|
+
/**
|
|
9516
|
+
* Gets current value of property {@link #getName name}.
|
|
9517
|
+
*
|
|
9518
|
+
* Unique control name for identification on the server side after sending data to the server.
|
|
9519
|
+
*
|
|
9520
|
+
*
|
|
9521
|
+
* @returns Value of property `name`
|
|
9522
|
+
*/
|
|
9523
|
+
getName(): string;
|
|
9524
|
+
/**
|
|
9525
|
+
* Gets content of aggregation {@link #getParameters parameters}.
|
|
9526
|
+
*
|
|
9527
|
+
* The parameters for the `FileUploader` which are rendered as a hidden input field.
|
|
9528
|
+
*
|
|
9529
|
+
* @since 1.12.2
|
|
9530
|
+
*/
|
|
9531
|
+
getParameters(): FileUploaderParameter[];
|
|
9532
|
+
/**
|
|
9533
|
+
* Gets current value of property {@link #getPlaceholder placeholder}.
|
|
9534
|
+
*
|
|
9535
|
+
* Placeholder for the text field.
|
|
9536
|
+
*
|
|
9537
|
+
*
|
|
9538
|
+
* @returns Value of property `placeholder`
|
|
9539
|
+
*/
|
|
9540
|
+
getPlaceholder(): string;
|
|
9541
|
+
/**
|
|
9542
|
+
* Allows to process Blobs before they get uploaded. This API can be used to create custom Blobs and upload
|
|
9543
|
+
* these custom Blobs instead of the received/initials Blobs in the parameter `aBlobs`. One use case could
|
|
9544
|
+
* be to create and upload zip archives based on the passed Blobs. The default implementation of this API
|
|
9545
|
+
* should simply resolve with the received Blobs (parameter `aBlobs`).
|
|
9546
|
+
*
|
|
9547
|
+
* This API is only supported in case `sendXHR` is `true`. This means only IE10+ is supported, while IE9
|
|
9548
|
+
* and below is not.
|
|
9549
|
+
*
|
|
9550
|
+
* This is a default implementation of the interface `sap.ui.commons.IProcessableBlobs`.
|
|
9551
|
+
*
|
|
9552
|
+
* @since 1.52
|
|
9553
|
+
*
|
|
9554
|
+
* @returns A Promise that resolves with an array of Blobs which is used for the final uploading.
|
|
9555
|
+
*/
|
|
9556
|
+
getProcessedBlobsFromArray(
|
|
9557
|
+
/**
|
|
9558
|
+
* The initial Blobs which can be used to determine/calculate a new array of Blobs for further processing.
|
|
9559
|
+
*/
|
|
9560
|
+
aBlobs: Blob[]
|
|
9561
|
+
): Promise<Blob[]>;
|
|
9562
|
+
/**
|
|
9563
|
+
* Gets current value of property {@link #getSameFilenameAllowed sameFilenameAllowed}.
|
|
9564
|
+
*
|
|
9565
|
+
* If the FileUploader is configured to upload the file directly after the file is selected, it is not allowed
|
|
9566
|
+
* to upload a file with the same name again. If a user should be allowed to upload a file with the same
|
|
9567
|
+
* name again this parameter has to be "true".
|
|
9568
|
+
*
|
|
9569
|
+
* A typical use case would be if the files have different paths.
|
|
9570
|
+
*
|
|
9571
|
+
* Default value is `false`.
|
|
9572
|
+
*
|
|
9573
|
+
*
|
|
9574
|
+
* @returns Value of property `sameFilenameAllowed`
|
|
9575
|
+
*/
|
|
9576
|
+
getSameFilenameAllowed(): boolean;
|
|
9577
|
+
/**
|
|
9578
|
+
* Gets current value of property {@link #getSendXHR sendXHR}.
|
|
9579
|
+
*
|
|
9580
|
+
* If set to "true", the request will be sent as XHR request instead of a form submit.
|
|
9581
|
+
*
|
|
9582
|
+
* This property is not supported by Internet Explorer 9.
|
|
9583
|
+
*
|
|
9584
|
+
* Default value is `false`.
|
|
9585
|
+
*
|
|
9586
|
+
*
|
|
9587
|
+
* @returns Value of property `sendXHR`
|
|
9588
|
+
*/
|
|
9589
|
+
getSendXHR(): boolean;
|
|
9590
|
+
/**
|
|
9591
|
+
* Gets current value of property {@link #getStyle style}.
|
|
9592
|
+
*
|
|
9593
|
+
* Style of the button.
|
|
9594
|
+
*
|
|
9595
|
+
* Values "Transparent, "Accept", "Reject", or "Emphasized" are allowed.
|
|
9596
|
+
*
|
|
9597
|
+
*
|
|
9598
|
+
* @returns Value of property `style`
|
|
9599
|
+
*/
|
|
9600
|
+
getStyle(): string;
|
|
9601
|
+
/**
|
|
9602
|
+
* Gets current value of property {@link #getUploadOnChange uploadOnChange}.
|
|
9603
|
+
*
|
|
9604
|
+
* If set to "true", the upload immediately starts after file selection. With the default setting, the upload
|
|
9605
|
+
* needs to be explicitly triggered.
|
|
9606
|
+
*
|
|
9607
|
+
* Default value is `false`.
|
|
9608
|
+
*
|
|
9609
|
+
*
|
|
9610
|
+
* @returns Value of property `uploadOnChange`
|
|
9611
|
+
*/
|
|
9612
|
+
getUploadOnChange(): boolean;
|
|
9613
|
+
/**
|
|
9614
|
+
* Gets current value of property {@link #getUploadUrl uploadUrl}.
|
|
9615
|
+
*
|
|
9616
|
+
* Used when URL address is on a remote server.
|
|
9617
|
+
*
|
|
9618
|
+
* Default value is `empty string`.
|
|
9619
|
+
*
|
|
9620
|
+
*
|
|
9621
|
+
* @returns Value of property `uploadUrl`
|
|
9622
|
+
*/
|
|
9623
|
+
getUploadUrl(): URI;
|
|
9624
|
+
/**
|
|
9625
|
+
* Gets current value of property {@link #getUseMultipart useMultipart}.
|
|
9626
|
+
*
|
|
9627
|
+
* If set to "false", the request will be sent as file only request instead of a multipart/form-data request.
|
|
9628
|
+
*
|
|
9629
|
+
* Only one file could be uploaded using this type of request. Required for sending such a request is to
|
|
9630
|
+
* set the property `sendXHR` to "true". This property is not supported by Internet Explorer 9.
|
|
9631
|
+
*
|
|
9632
|
+
* Default value is `true`.
|
|
9633
|
+
*
|
|
9634
|
+
*
|
|
9635
|
+
* @returns Value of property `useMultipart`
|
|
9636
|
+
*/
|
|
9637
|
+
getUseMultipart(): boolean;
|
|
9638
|
+
/**
|
|
9639
|
+
* Gets current value of property {@link #getValue value}.
|
|
9640
|
+
*
|
|
9641
|
+
* Value of the path for file upload.
|
|
9642
|
+
*
|
|
9643
|
+
* Default value is `empty string`.
|
|
9644
|
+
*
|
|
9645
|
+
*
|
|
9646
|
+
* @returns Value of property `value`
|
|
9647
|
+
*/
|
|
9648
|
+
getValue(): string;
|
|
9649
|
+
/**
|
|
9650
|
+
* Gets current value of property {@link #getValueState valueState}.
|
|
9651
|
+
*
|
|
9652
|
+
* Visualizes warnings or errors related to the text field.
|
|
9653
|
+
*
|
|
9654
|
+
* Possible values: Warning, Error, Success, None.
|
|
9655
|
+
*
|
|
9656
|
+
* Default value is `None`.
|
|
9657
|
+
*
|
|
9658
|
+
* @since 1.24.0
|
|
9659
|
+
*
|
|
9660
|
+
* @returns Value of property `valueState`
|
|
9661
|
+
*/
|
|
9662
|
+
getValueState(): ValueState;
|
|
9663
|
+
/**
|
|
9664
|
+
* Gets current value of property {@link #getValueStateText valueStateText}.
|
|
9665
|
+
*
|
|
9666
|
+
* Custom text for the value state message pop-up.
|
|
9667
|
+
*
|
|
9668
|
+
* **Note:** If not specified, a default text, based on the value state type, will be used instead.
|
|
9669
|
+
*
|
|
9670
|
+
* @since 1.52
|
|
9671
|
+
*
|
|
9672
|
+
* @returns Value of property `valueStateText`
|
|
9673
|
+
*/
|
|
9674
|
+
getValueStateText(): string;
|
|
9675
|
+
/**
|
|
9676
|
+
* Gets current value of property {@link #getWidth width}.
|
|
9677
|
+
*
|
|
9678
|
+
* Specifies the displayed control width.
|
|
9679
|
+
*
|
|
9680
|
+
* Default value is `empty string`.
|
|
9681
|
+
*
|
|
9682
|
+
*
|
|
9683
|
+
* @returns Value of property `width`
|
|
9684
|
+
*/
|
|
9685
|
+
getWidth(): CSSSize;
|
|
9686
|
+
/**
|
|
9687
|
+
* Gets content of aggregation {@link #getXhrSettings xhrSettings}.
|
|
9688
|
+
*
|
|
9689
|
+
* Settings for the `XMLHttpRequest` object. **Note:** This aggregation is only used when the `sendXHR`
|
|
9690
|
+
* property is set to `true`.
|
|
9691
|
+
*
|
|
9692
|
+
* @since 1.52
|
|
9693
|
+
*/
|
|
9694
|
+
getXhrSettings(): FileUploaderXHRSettings;
|
|
9695
|
+
/**
|
|
9696
|
+
* Checks for the provided `sap.ui.commons.FileUploaderParameter` in the aggregation {@link #getHeaderParameters headerParameters}.
|
|
9697
|
+
* and returns its index if found or -1 otherwise.
|
|
9698
|
+
*
|
|
9699
|
+
*
|
|
9700
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
9701
|
+
*/
|
|
9702
|
+
indexOfHeaderParameter(
|
|
9703
|
+
/**
|
|
9704
|
+
* The headerParameter whose index is looked for
|
|
9705
|
+
*/
|
|
9706
|
+
oHeaderParameter: FileUploaderParameter
|
|
9707
|
+
): int;
|
|
9708
|
+
/**
|
|
9709
|
+
* Checks for the provided `sap.ui.commons.FileUploaderParameter` in the aggregation {@link #getParameters parameters}.
|
|
9710
|
+
* and returns its index if found or -1 otherwise.
|
|
9711
|
+
*
|
|
9712
|
+
* @since 1.12.2
|
|
9713
|
+
*
|
|
9714
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
9715
|
+
*/
|
|
9716
|
+
indexOfParameter(
|
|
9717
|
+
/**
|
|
9718
|
+
* The parameter whose index is looked for
|
|
9719
|
+
*/
|
|
9720
|
+
oParameter: FileUploaderParameter
|
|
9721
|
+
): int;
|
|
9722
|
+
/**
|
|
9723
|
+
* Inserts a headerParameter into the aggregation {@link #getHeaderParameters headerParameters}.
|
|
9724
|
+
*
|
|
9725
|
+
*
|
|
9726
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9727
|
+
*/
|
|
9728
|
+
insertHeaderParameter(
|
|
9729
|
+
/**
|
|
9730
|
+
* The headerParameter to insert; if empty, nothing is inserted
|
|
9731
|
+
*/
|
|
9732
|
+
oHeaderParameter: FileUploaderParameter,
|
|
9733
|
+
/**
|
|
9734
|
+
* The `0`-based index the headerParameter should be inserted at; for a negative value of `iIndex`, the
|
|
9735
|
+
* headerParameter is inserted at position 0; for a value greater than the current size of the aggregation,
|
|
9736
|
+
* the headerParameter is inserted at the last position
|
|
9737
|
+
*/
|
|
9738
|
+
iIndex: int
|
|
9739
|
+
): this;
|
|
9740
|
+
/**
|
|
9741
|
+
* Inserts a parameter into the aggregation {@link #getParameters parameters}.
|
|
9742
|
+
*
|
|
9743
|
+
* @since 1.12.2
|
|
9744
|
+
*
|
|
9745
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9746
|
+
*/
|
|
9747
|
+
insertParameter(
|
|
9748
|
+
/**
|
|
9749
|
+
* The parameter to insert; if empty, nothing is inserted
|
|
9750
|
+
*/
|
|
9751
|
+
oParameter: FileUploaderParameter,
|
|
9752
|
+
/**
|
|
9753
|
+
* The `0`-based index the parameter should be inserted at; for a negative value of `iIndex`, the parameter
|
|
9754
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the parameter
|
|
9755
|
+
* is inserted at the last position
|
|
9756
|
+
*/
|
|
9757
|
+
iIndex: int
|
|
9758
|
+
): this;
|
|
9759
|
+
/**
|
|
9760
|
+
* Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
|
|
9761
|
+
*
|
|
9762
|
+
*
|
|
9763
|
+
* @returns An array of the removed elements (might be empty)
|
|
9764
|
+
*/
|
|
9765
|
+
removeAllAriaDescribedBy(): ID[];
|
|
9766
|
+
/**
|
|
9767
|
+
* Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
|
|
9768
|
+
*
|
|
9769
|
+
*
|
|
9770
|
+
* @returns An array of the removed elements (might be empty)
|
|
9771
|
+
*/
|
|
9772
|
+
removeAllAriaLabelledBy(): ID[];
|
|
9773
|
+
/**
|
|
9774
|
+
* Removes all the controls from the aggregation {@link #getHeaderParameters headerParameters}.
|
|
9775
|
+
*
|
|
9776
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
9777
|
+
*
|
|
9778
|
+
*
|
|
9779
|
+
* @returns An array of the removed elements (might be empty)
|
|
9780
|
+
*/
|
|
9781
|
+
removeAllHeaderParameters(): FileUploaderParameter[];
|
|
9782
|
+
/**
|
|
9783
|
+
* Removes all the controls from the aggregation {@link #getParameters parameters}.
|
|
9784
|
+
*
|
|
9785
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
9786
|
+
*
|
|
9787
|
+
* @since 1.12.2
|
|
9788
|
+
*
|
|
9789
|
+
* @returns An array of the removed elements (might be empty)
|
|
9790
|
+
*/
|
|
9791
|
+
removeAllParameters(): FileUploaderParameter[];
|
|
9792
|
+
/**
|
|
9793
|
+
* Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
|
|
9794
|
+
*
|
|
9795
|
+
*
|
|
9796
|
+
* @returns The removed ariaDescribedBy or `null`
|
|
9797
|
+
*/
|
|
9798
|
+
removeAriaDescribedBy(
|
|
9799
|
+
/**
|
|
9800
|
+
* The ariaDescribedBy to be removed or its index or ID
|
|
9801
|
+
*/
|
|
9802
|
+
vAriaDescribedBy: int | ID | Control
|
|
9803
|
+
): ID | null;
|
|
9804
|
+
/**
|
|
9805
|
+
* Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
|
|
9806
|
+
*
|
|
9807
|
+
*
|
|
9808
|
+
* @returns The removed ariaLabelledBy or `null`
|
|
9809
|
+
*/
|
|
9810
|
+
removeAriaLabelledBy(
|
|
9811
|
+
/**
|
|
9812
|
+
* The ariaLabelledBy to be removed or its index or ID
|
|
9813
|
+
*/
|
|
9814
|
+
vAriaLabelledBy: int | ID | Control
|
|
9815
|
+
): ID | null;
|
|
9816
|
+
/**
|
|
9817
|
+
* Removes a headerParameter from the aggregation {@link #getHeaderParameters headerParameters}.
|
|
9818
|
+
*
|
|
9819
|
+
*
|
|
9820
|
+
* @returns The removed headerParameter or `null`
|
|
9821
|
+
*/
|
|
9822
|
+
removeHeaderParameter(
|
|
9823
|
+
/**
|
|
9824
|
+
* The headerParameter to remove or its index or id
|
|
9825
|
+
*/
|
|
9826
|
+
vHeaderParameter: int | string | FileUploaderParameter
|
|
9827
|
+
): FileUploaderParameter | null;
|
|
9828
|
+
/**
|
|
9829
|
+
* Removes a parameter from the aggregation {@link #getParameters parameters}.
|
|
9830
|
+
*
|
|
9831
|
+
* @since 1.12.2
|
|
9832
|
+
*
|
|
9833
|
+
* @returns The removed parameter or `null`
|
|
9834
|
+
*/
|
|
9835
|
+
removeParameter(
|
|
9836
|
+
/**
|
|
9837
|
+
* The parameter to remove or its index or id
|
|
9838
|
+
*/
|
|
9839
|
+
vParameter: int | string | FileUploaderParameter
|
|
9840
|
+
): FileUploaderParameter | null;
|
|
9841
|
+
/**
|
|
9842
|
+
* Sets a new value for property {@link #getAdditionalData additionalData}.
|
|
9843
|
+
*
|
|
9844
|
+
* Additional data that is sent to the back end service.
|
|
9845
|
+
*
|
|
9846
|
+
* Data will be transmitted as value of a hidden input where the name is derived from the `name` property
|
|
9847
|
+
* with suffix "-data".
|
|
9848
|
+
*
|
|
9849
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9850
|
+
*
|
|
9851
|
+
*
|
|
9852
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9853
|
+
*/
|
|
9854
|
+
setAdditionalData(
|
|
9855
|
+
/**
|
|
9856
|
+
* New value for property `additionalData`
|
|
9857
|
+
*/
|
|
9858
|
+
sAdditionalData?: string
|
|
9859
|
+
): this;
|
|
9860
|
+
/**
|
|
9861
|
+
* Sets a new value for property {@link #getButtonOnly buttonOnly}.
|
|
9862
|
+
*
|
|
9863
|
+
* If set to "true", the `FileUploader` will be rendered as Button only, without showing the input field.
|
|
9864
|
+
*
|
|
9865
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9866
|
+
*
|
|
9867
|
+
* Default value is `false`.
|
|
9868
|
+
*
|
|
9869
|
+
*
|
|
9870
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9871
|
+
*/
|
|
9872
|
+
setButtonOnly(
|
|
9873
|
+
/**
|
|
9874
|
+
* New value for property `buttonOnly`
|
|
9875
|
+
*/
|
|
9876
|
+
bButtonOnly?: boolean
|
|
9877
|
+
): this;
|
|
9878
|
+
/**
|
|
9879
|
+
* Sets a new value for property {@link #getButtonText buttonText}.
|
|
9880
|
+
*
|
|
9881
|
+
* The button's text can be overwritten using this property.
|
|
9882
|
+
*
|
|
9883
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9884
|
+
*
|
|
9885
|
+
*
|
|
9886
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9887
|
+
*/
|
|
9888
|
+
setButtonText(
|
|
9889
|
+
/**
|
|
9890
|
+
* New value for property `buttonText`
|
|
9891
|
+
*/
|
|
9892
|
+
sButtonText?: string
|
|
9893
|
+
): this;
|
|
9894
|
+
/**
|
|
9895
|
+
* Sets a new value for property {@link #getDirectory directory}.
|
|
9896
|
+
*
|
|
9897
|
+
* Allows users to upload all files from a given directory and its corresponding subdirectories.
|
|
9898
|
+
*
|
|
9899
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9900
|
+
*
|
|
9901
|
+
* Default value is `false`.
|
|
9902
|
+
*
|
|
9903
|
+
* @since 1.105.0
|
|
9904
|
+
*
|
|
9905
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9906
|
+
*/
|
|
9907
|
+
setDirectory(
|
|
9908
|
+
/**
|
|
9909
|
+
* New value for property `directory`
|
|
9910
|
+
*/
|
|
9911
|
+
bDirectory?: boolean
|
|
9912
|
+
): this;
|
|
9913
|
+
/**
|
|
9914
|
+
* Sets a new value for property {@link #getEnabled enabled}.
|
|
9915
|
+
*
|
|
9916
|
+
* Disabled controls have different colors, depending on customer settings.
|
|
9917
|
+
*
|
|
9918
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9919
|
+
*
|
|
9920
|
+
* Default value is `true`.
|
|
9921
|
+
*
|
|
9922
|
+
*
|
|
9923
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9924
|
+
*/
|
|
9925
|
+
setEnabled(
|
|
9926
|
+
/**
|
|
9927
|
+
* New value for property `enabled`
|
|
9928
|
+
*/
|
|
9929
|
+
bEnabled?: boolean
|
|
9930
|
+
): this;
|
|
9931
|
+
/**
|
|
9932
|
+
* Sets a new value for property {@link #getFileType fileType}.
|
|
9933
|
+
*
|
|
9934
|
+
* The chosen files will be checked against an array of file types.
|
|
9935
|
+
*
|
|
9936
|
+
* If at least one file does not fit the file type restriction, the upload is prevented. **Note:** This
|
|
9937
|
+
* property is not supported by Microsoft Edge.
|
|
9938
|
+
*
|
|
9939
|
+
* Example: `["jpg", "png", "bmp"]`.
|
|
9940
|
+
*
|
|
9941
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9942
|
+
*
|
|
9943
|
+
*
|
|
9944
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9945
|
+
*/
|
|
9946
|
+
setFileType(
|
|
9947
|
+
/**
|
|
9948
|
+
* New value for property `fileType`
|
|
9949
|
+
*/
|
|
9950
|
+
sFileType?: string[]
|
|
9951
|
+
): this;
|
|
9952
|
+
/**
|
|
9953
|
+
* Sets a new value for property {@link #getHttpRequestMethod httpRequestMethod}.
|
|
9954
|
+
*
|
|
9955
|
+
* Chosen HTTP request method for file upload.
|
|
9956
|
+
*
|
|
9957
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9958
|
+
*
|
|
9959
|
+
* Default value is `Post`.
|
|
9960
|
+
*
|
|
9961
|
+
* @since 1.81.0
|
|
9962
|
+
*
|
|
9963
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9964
|
+
*/
|
|
9965
|
+
setHttpRequestMethod(
|
|
9966
|
+
/**
|
|
9967
|
+
* New value for property `httpRequestMethod`
|
|
9968
|
+
*/
|
|
9969
|
+
sHttpRequestMethod?: FileUploaderHttpRequestMethod
|
|
9970
|
+
): this;
|
|
9971
|
+
/**
|
|
9972
|
+
* Sets a new value for property {@link #getIcon icon}.
|
|
9973
|
+
*
|
|
9974
|
+
* Icon to be displayed as graphical element within the button.
|
|
9975
|
+
*
|
|
9976
|
+
* This can be a URI to an image or an icon font URI.
|
|
9977
|
+
*
|
|
9978
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9979
|
+
*
|
|
9980
|
+
* Default value is `empty string`.
|
|
9981
|
+
*
|
|
9982
|
+
* @since 1.26.0
|
|
9983
|
+
*
|
|
9984
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
9985
|
+
*/
|
|
9986
|
+
setIcon(
|
|
9987
|
+
/**
|
|
9988
|
+
* New value for property `icon`
|
|
9989
|
+
*/
|
|
9990
|
+
sIcon?: URI
|
|
9991
|
+
): this;
|
|
9992
|
+
/**
|
|
9993
|
+
* Sets a new value for property {@link #getIconFirst iconFirst}.
|
|
9994
|
+
*
|
|
9995
|
+
* If set to true (default), the display sequence is 1. icon 2. control text.
|
|
9996
|
+
*
|
|
9997
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
9998
|
+
*
|
|
9999
|
+
* Default value is `true`.
|
|
10000
|
+
*
|
|
10001
|
+
* @since 1.26.0
|
|
10002
|
+
*
|
|
10003
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10004
|
+
*/
|
|
10005
|
+
setIconFirst(
|
|
10006
|
+
/**
|
|
10007
|
+
* New value for property `iconFirst`
|
|
10008
|
+
*/
|
|
10009
|
+
bIconFirst?: boolean
|
|
10010
|
+
): this;
|
|
10011
|
+
/**
|
|
10012
|
+
* Sets a new value for property {@link #getIconHovered iconHovered}.
|
|
10013
|
+
*
|
|
10014
|
+
* Icon to be displayed as graphical element within the button when it is hovered (only if also a base icon
|
|
10015
|
+
* was specified).
|
|
10016
|
+
*
|
|
10017
|
+
* If not specified, the base icon is used. If an icon font icon is used, this property is ignored.
|
|
10018
|
+
*
|
|
10019
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10020
|
+
*
|
|
10021
|
+
* Default value is `empty string`.
|
|
10022
|
+
*
|
|
10023
|
+
* @since 1.26.0
|
|
10024
|
+
*
|
|
10025
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10026
|
+
*/
|
|
10027
|
+
setIconHovered(
|
|
10028
|
+
/**
|
|
10029
|
+
* New value for property `iconHovered`
|
|
10030
|
+
*/
|
|
10031
|
+
sIconHovered?: URI
|
|
10032
|
+
): this;
|
|
10033
|
+
/**
|
|
10034
|
+
* Sets a new value for property {@link #getIconOnly iconOnly}.
|
|
10035
|
+
*
|
|
10036
|
+
* If set to true, the button is displayed without any text.
|
|
10037
|
+
*
|
|
10038
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10039
|
+
*
|
|
10040
|
+
* Default value is `false`.
|
|
10041
|
+
*
|
|
10042
|
+
* @since 1.26.0
|
|
10043
|
+
*
|
|
10044
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10045
|
+
*/
|
|
10046
|
+
setIconOnly(
|
|
10047
|
+
/**
|
|
10048
|
+
* New value for property `iconOnly`
|
|
10049
|
+
*/
|
|
10050
|
+
bIconOnly?: boolean
|
|
10051
|
+
): this;
|
|
10052
|
+
/**
|
|
10053
|
+
* Sets a new value for property {@link #getIconSelected iconSelected}.
|
|
10054
|
+
*
|
|
10055
|
+
* Icon to be displayed as graphical element within the button when it is selected (only if also a base
|
|
10056
|
+
* icon was specified).
|
|
10057
|
+
*
|
|
10058
|
+
* If not specified, the base or hovered icon is used. If an icon font icon is used, this property is ignored.
|
|
10059
|
+
*
|
|
10060
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10061
|
+
*
|
|
10062
|
+
* Default value is `empty string`.
|
|
10063
|
+
*
|
|
10064
|
+
* @since 1.26.0
|
|
10065
|
+
*
|
|
10066
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10067
|
+
*/
|
|
10068
|
+
setIconSelected(
|
|
10069
|
+
/**
|
|
10070
|
+
* New value for property `iconSelected`
|
|
10071
|
+
*/
|
|
10072
|
+
sIconSelected?: URI
|
|
10073
|
+
): this;
|
|
10074
|
+
/**
|
|
10075
|
+
* Sets a new value for property {@link #getMaximumFilenameLength maximumFilenameLength}.
|
|
10076
|
+
*
|
|
10077
|
+
* The maximum length of a filename which the `FileUploader` will accept.
|
|
10078
|
+
*
|
|
10079
|
+
* If the maximum filename length is exceeded, the corresponding event `filenameLengthExceed` is fired.
|
|
10080
|
+
*
|
|
10081
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10082
|
+
*
|
|
10083
|
+
* @since 1.24.0
|
|
10084
|
+
*
|
|
10085
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10086
|
+
*/
|
|
10087
|
+
setMaximumFilenameLength(
|
|
10088
|
+
/**
|
|
10089
|
+
* New value for property `maximumFilenameLength`
|
|
10090
|
+
*/
|
|
10091
|
+
iMaximumFilenameLength?: int
|
|
10092
|
+
): this;
|
|
10093
|
+
/**
|
|
10094
|
+
* Sets a new value for property {@link #getMaximumFileSize maximumFileSize}.
|
|
10095
|
+
*
|
|
10096
|
+
* A file size limit in megabytes which prevents the upload if at least one file exceeds it.
|
|
10097
|
+
*
|
|
10098
|
+
* This property is not supported by Internet Explorer 9.
|
|
10099
|
+
*
|
|
10100
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10101
|
+
*
|
|
10102
|
+
*
|
|
10103
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10104
|
+
*/
|
|
10105
|
+
setMaximumFileSize(
|
|
10106
|
+
/**
|
|
10107
|
+
* New value for property `maximumFileSize`
|
|
10108
|
+
*/
|
|
10109
|
+
fMaximumFileSize?: float
|
|
10110
|
+
): this;
|
|
10111
|
+
/**
|
|
10112
|
+
* Sets a new value for property {@link #getMimeType mimeType}.
|
|
10113
|
+
*
|
|
10114
|
+
* The chosen files will be checked against an array of MIME types defined in this property.
|
|
10115
|
+
*
|
|
10116
|
+
* If at least one file does not fit the MIME type restriction, the upload is prevented.
|
|
10117
|
+
*
|
|
10118
|
+
* **Note:** This property is not supported by Internet Explorer. It is only reliable for common file types
|
|
10119
|
+
* like images, audio, video, plain text and HTML documents. File types that are not recognized by the browser
|
|
10120
|
+
* result in `file.type` to be returned as an empty string. In this case the verification could not be performed.
|
|
10121
|
+
* The file upload is not prevented and the validation based on file type is left to the receiving backend
|
|
10122
|
+
* side.
|
|
10123
|
+
*
|
|
10124
|
+
* Example: `["image/png", "image/jpeg"]`.
|
|
10125
|
+
*
|
|
10126
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10127
|
+
*
|
|
10128
|
+
*
|
|
10129
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10130
|
+
*/
|
|
10131
|
+
setMimeType(
|
|
10132
|
+
/**
|
|
10133
|
+
* New value for property `mimeType`
|
|
10134
|
+
*/
|
|
10135
|
+
sMimeType?: string[]
|
|
10136
|
+
): this;
|
|
10137
|
+
/**
|
|
10138
|
+
* Sets a new value for property {@link #getMultiple multiple}.
|
|
10139
|
+
*
|
|
10140
|
+
* Allows multiple files to be chosen and uploaded from the same folder.
|
|
10141
|
+
*
|
|
10142
|
+
* This property is not supported by Internet Explorer 9.
|
|
10143
|
+
*
|
|
10144
|
+
* **Note:** Keep in mind that the various operating systems for mobile devices can react differently to
|
|
10145
|
+
* the property so that fewer upload functions may be available in some cases.
|
|
10146
|
+
*
|
|
10147
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10148
|
+
*
|
|
10149
|
+
* Default value is `false`.
|
|
10150
|
+
*
|
|
10151
|
+
*
|
|
10152
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10153
|
+
*/
|
|
10154
|
+
setMultiple(
|
|
10155
|
+
/**
|
|
10156
|
+
* New value for property `multiple`
|
|
10157
|
+
*/
|
|
10158
|
+
bMultiple?: boolean
|
|
10159
|
+
): this;
|
|
10160
|
+
/**
|
|
10161
|
+
* Sets a new value for property {@link #getName name}.
|
|
10162
|
+
*
|
|
10163
|
+
* Unique control name for identification on the server side after sending data to the server.
|
|
10164
|
+
*
|
|
10165
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10166
|
+
*
|
|
10167
|
+
*
|
|
10168
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10169
|
+
*/
|
|
10170
|
+
setName(
|
|
10171
|
+
/**
|
|
10172
|
+
* New value for property `name`
|
|
10173
|
+
*/
|
|
10174
|
+
sName?: string
|
|
10175
|
+
): this;
|
|
10176
|
+
/**
|
|
10177
|
+
* Sets a new value for property {@link #getPlaceholder placeholder}.
|
|
10178
|
+
*
|
|
10179
|
+
* Placeholder for the text field.
|
|
10180
|
+
*
|
|
10181
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10182
|
+
*
|
|
10183
|
+
*
|
|
10184
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10185
|
+
*/
|
|
10186
|
+
setPlaceholder(
|
|
10187
|
+
/**
|
|
10188
|
+
* New value for property `placeholder`
|
|
10189
|
+
*/
|
|
10190
|
+
sPlaceholder?: string
|
|
10191
|
+
): this;
|
|
10192
|
+
/**
|
|
10193
|
+
* Sets a new value for property {@link #getSameFilenameAllowed sameFilenameAllowed}.
|
|
10194
|
+
*
|
|
10195
|
+
* If the FileUploader is configured to upload the file directly after the file is selected, it is not allowed
|
|
10196
|
+
* to upload a file with the same name again. If a user should be allowed to upload a file with the same
|
|
10197
|
+
* name again this parameter has to be "true".
|
|
10198
|
+
*
|
|
10199
|
+
* A typical use case would be if the files have different paths.
|
|
10200
|
+
*
|
|
10201
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10202
|
+
*
|
|
10203
|
+
* Default value is `false`.
|
|
10204
|
+
*
|
|
10205
|
+
*
|
|
10206
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10207
|
+
*/
|
|
10208
|
+
setSameFilenameAllowed(
|
|
10209
|
+
/**
|
|
10210
|
+
* New value for property `sameFilenameAllowed`
|
|
10211
|
+
*/
|
|
10212
|
+
bSameFilenameAllowed?: boolean
|
|
10213
|
+
): this;
|
|
10214
|
+
/**
|
|
10215
|
+
* Sets a new value for property {@link #getSendXHR sendXHR}.
|
|
10216
|
+
*
|
|
10217
|
+
* If set to "true", the request will be sent as XHR request instead of a form submit.
|
|
10218
|
+
*
|
|
10219
|
+
* This property is not supported by Internet Explorer 9.
|
|
10220
|
+
*
|
|
10221
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10222
|
+
*
|
|
10223
|
+
* Default value is `false`.
|
|
10224
|
+
*
|
|
10225
|
+
*
|
|
10226
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10227
|
+
*/
|
|
10228
|
+
setSendXHR(
|
|
10229
|
+
/**
|
|
10230
|
+
* New value for property `sendXHR`
|
|
10231
|
+
*/
|
|
10232
|
+
bSendXHR?: boolean
|
|
10233
|
+
): this;
|
|
10234
|
+
/**
|
|
10235
|
+
* Sets a new value for property {@link #getStyle style}.
|
|
10236
|
+
*
|
|
10237
|
+
* Style of the button.
|
|
10238
|
+
*
|
|
10239
|
+
* Values "Transparent, "Accept", "Reject", or "Emphasized" are allowed.
|
|
10240
|
+
*
|
|
10241
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10242
|
+
*
|
|
10243
|
+
*
|
|
10244
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10245
|
+
*/
|
|
10246
|
+
setStyle(
|
|
10247
|
+
/**
|
|
10248
|
+
* New value for property `style`
|
|
10249
|
+
*/
|
|
10250
|
+
sStyle?: string
|
|
10251
|
+
): this;
|
|
10252
|
+
/**
|
|
10253
|
+
* Sets a new value for property {@link #getUploadOnChange uploadOnChange}.
|
|
10254
|
+
*
|
|
10255
|
+
* If set to "true", the upload immediately starts after file selection. With the default setting, the upload
|
|
10256
|
+
* needs to be explicitly triggered.
|
|
10257
|
+
*
|
|
10258
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10259
|
+
*
|
|
10260
|
+
* Default value is `false`.
|
|
10261
|
+
*
|
|
10262
|
+
*
|
|
10263
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10264
|
+
*/
|
|
10265
|
+
setUploadOnChange(
|
|
10266
|
+
/**
|
|
10267
|
+
* New value for property `uploadOnChange`
|
|
10268
|
+
*/
|
|
10269
|
+
bUploadOnChange?: boolean
|
|
10270
|
+
): this;
|
|
10271
|
+
/**
|
|
10272
|
+
* Sets a new value for property {@link #getUploadUrl uploadUrl}.
|
|
10273
|
+
*
|
|
10274
|
+
* Used when URL address is on a remote server.
|
|
10275
|
+
*
|
|
10276
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10277
|
+
*
|
|
10278
|
+
* Default value is `empty string`.
|
|
10279
|
+
*
|
|
10280
|
+
*
|
|
10281
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10282
|
+
*/
|
|
10283
|
+
setUploadUrl(
|
|
10284
|
+
/**
|
|
10285
|
+
* New value for property `uploadUrl`
|
|
10286
|
+
*/
|
|
10287
|
+
sUploadUrl?: URI
|
|
10288
|
+
): this;
|
|
10289
|
+
/**
|
|
10290
|
+
* Sets a new value for property {@link #getUseMultipart useMultipart}.
|
|
10291
|
+
*
|
|
10292
|
+
* If set to "false", the request will be sent as file only request instead of a multipart/form-data request.
|
|
10293
|
+
*
|
|
10294
|
+
* Only one file could be uploaded using this type of request. Required for sending such a request is to
|
|
10295
|
+
* set the property `sendXHR` to "true". This property is not supported by Internet Explorer 9.
|
|
10296
|
+
*
|
|
10297
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10298
|
+
*
|
|
10299
|
+
* Default value is `true`.
|
|
10300
|
+
*
|
|
10301
|
+
*
|
|
10302
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10303
|
+
*/
|
|
10304
|
+
setUseMultipart(
|
|
10305
|
+
/**
|
|
10306
|
+
* New value for property `useMultipart`
|
|
10307
|
+
*/
|
|
10308
|
+
bUseMultipart?: boolean
|
|
10309
|
+
): this;
|
|
10310
|
+
/**
|
|
10311
|
+
* Sets a new value for property {@link #getValue value}.
|
|
10312
|
+
*
|
|
10313
|
+
* Value of the path for file upload.
|
|
10314
|
+
*
|
|
10315
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10316
|
+
*
|
|
10317
|
+
* Default value is `empty string`.
|
|
10318
|
+
*
|
|
10319
|
+
*
|
|
10320
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10321
|
+
*/
|
|
10322
|
+
setValue(
|
|
10323
|
+
/**
|
|
10324
|
+
* New value for property `value`
|
|
10325
|
+
*/
|
|
10326
|
+
sValue?: string
|
|
10327
|
+
): this;
|
|
10328
|
+
/**
|
|
10329
|
+
* Sets a new value for property {@link #getValueState valueState}.
|
|
10330
|
+
*
|
|
10331
|
+
* Visualizes warnings or errors related to the text field.
|
|
10332
|
+
*
|
|
10333
|
+
* Possible values: Warning, Error, Success, None.
|
|
10334
|
+
*
|
|
10335
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10336
|
+
*
|
|
10337
|
+
* Default value is `None`.
|
|
10338
|
+
*
|
|
10339
|
+
* @since 1.24.0
|
|
10340
|
+
*
|
|
10341
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10342
|
+
*/
|
|
10343
|
+
setValueState(
|
|
10344
|
+
/**
|
|
10345
|
+
* New value for property `valueState`
|
|
10346
|
+
*/
|
|
10347
|
+
sValueState?: ValueState | keyof typeof ValueState
|
|
10348
|
+
): this;
|
|
10349
|
+
/**
|
|
10350
|
+
* Sets a new value for property {@link #getValueStateText valueStateText}.
|
|
10351
|
+
*
|
|
10352
|
+
* Custom text for the value state message pop-up.
|
|
10353
|
+
*
|
|
10354
|
+
* **Note:** If not specified, a default text, based on the value state type, will be used instead.
|
|
10355
|
+
*
|
|
10356
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10357
|
+
*
|
|
10358
|
+
* @since 1.52
|
|
10359
|
+
*
|
|
10360
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10361
|
+
*/
|
|
10362
|
+
setValueStateText(
|
|
10363
|
+
/**
|
|
10364
|
+
* New value for property `valueStateText`
|
|
10365
|
+
*/
|
|
10366
|
+
sValueStateText?: string
|
|
10367
|
+
): this;
|
|
10368
|
+
/**
|
|
10369
|
+
* Sets a new value for property {@link #getWidth width}.
|
|
10370
|
+
*
|
|
10371
|
+
* Specifies the displayed control width.
|
|
10372
|
+
*
|
|
10373
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10374
|
+
*
|
|
10375
|
+
* Default value is `empty string`.
|
|
10376
|
+
*
|
|
10377
|
+
*
|
|
10378
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10379
|
+
*/
|
|
10380
|
+
setWidth(
|
|
10381
|
+
/**
|
|
10382
|
+
* New value for property `width`
|
|
10383
|
+
*/
|
|
10384
|
+
sWidth?: CSSSize
|
|
10385
|
+
): this;
|
|
10386
|
+
/**
|
|
10387
|
+
* Sets the aggregated {@link #getXhrSettings xhrSettings}.
|
|
10388
|
+
*
|
|
10389
|
+
* @since 1.52
|
|
10390
|
+
*
|
|
10391
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10392
|
+
*/
|
|
10393
|
+
setXhrSettings(
|
|
10394
|
+
/**
|
|
10395
|
+
* The xhrSettings to set
|
|
10396
|
+
*/
|
|
10397
|
+
oXhrSettings: FileUploaderXHRSettings
|
|
10398
|
+
): this;
|
|
10399
|
+
/**
|
|
10400
|
+
* Starts the upload (as defined by uploadUrl).
|
|
10401
|
+
*/
|
|
10402
|
+
upload(
|
|
10403
|
+
/**
|
|
10404
|
+
* Set to `true` to allow pre-processing of the files before sending the request. As a result, the `upload`
|
|
10405
|
+
* method becomes asynchronous. See {@link sap.ui.commons.IProcessableBlobs} for more information. **Note:**
|
|
10406
|
+
* This parameter is only taken into account when `sendXHR` is set to `true`.
|
|
10407
|
+
*/
|
|
10408
|
+
bPreProcessFiles?: boolean
|
|
10409
|
+
): void;
|
|
10410
|
+
}
|
|
10411
|
+
/**
|
|
10412
|
+
* Describes the settings that can be provided to the FileUploader constructor.
|
|
10413
|
+
*
|
|
10414
|
+
* @deprecated As of version 1.21.0. Please use the control sap.ui.unified.FileUploader of the library sap.ui.unified
|
|
10415
|
+
* instead.
|
|
10416
|
+
*/
|
|
10417
|
+
export interface $FileUploaderSettings extends $ControlSettings {
|
|
10418
|
+
/**
|
|
10419
|
+
* Value of the path for file upload.
|
|
10420
|
+
*/
|
|
10421
|
+
value?: string | PropertyBindingInfo;
|
|
10422
|
+
|
|
10423
|
+
/**
|
|
10424
|
+
* Disabled controls have different colors, depending on customer settings.
|
|
10425
|
+
*/
|
|
10426
|
+
enabled?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
10427
|
+
|
|
10428
|
+
/**
|
|
10429
|
+
* Used when URL address is on a remote server.
|
|
10430
|
+
*/
|
|
10431
|
+
uploadUrl?: URI | PropertyBindingInfo | `{${string}}`;
|
|
10432
|
+
|
|
10433
|
+
/**
|
|
10434
|
+
* Unique control name for identification on the server side after sending data to the server.
|
|
10435
|
+
*/
|
|
10436
|
+
name?: string | PropertyBindingInfo;
|
|
10437
|
+
|
|
10438
|
+
/**
|
|
10439
|
+
* Specifies the displayed control width.
|
|
10440
|
+
*/
|
|
10441
|
+
width?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
10442
|
+
|
|
10443
|
+
/**
|
|
10444
|
+
* If set to "true", the upload immediately starts after file selection. With the default setting, the upload
|
|
10445
|
+
* needs to be explicitly triggered.
|
|
10446
|
+
*/
|
|
10447
|
+
uploadOnChange?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
10448
|
+
|
|
10449
|
+
/**
|
|
10450
|
+
* Additional data that is sent to the back end service.
|
|
10451
|
+
*
|
|
10452
|
+
* Data will be transmitted as value of a hidden input where the name is derived from the `name` property
|
|
10453
|
+
* with suffix "-data".
|
|
10454
|
+
*/
|
|
10455
|
+
additionalData?: string | PropertyBindingInfo;
|
|
10456
|
+
|
|
10457
|
+
/**
|
|
10458
|
+
* If the FileUploader is configured to upload the file directly after the file is selected, it is not allowed
|
|
10459
|
+
* to upload a file with the same name again. If a user should be allowed to upload a file with the same
|
|
10460
|
+
* name again this parameter has to be "true".
|
|
10461
|
+
*
|
|
10462
|
+
* A typical use case would be if the files have different paths.
|
|
10463
|
+
*/
|
|
10464
|
+
sameFilenameAllowed?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
10465
|
+
|
|
10466
|
+
/**
|
|
10467
|
+
* The button's text can be overwritten using this property.
|
|
10468
|
+
*/
|
|
10469
|
+
buttonText?: string | PropertyBindingInfo;
|
|
10470
|
+
|
|
10471
|
+
/**
|
|
10472
|
+
* The chosen files will be checked against an array of file types.
|
|
10473
|
+
*
|
|
10474
|
+
* If at least one file does not fit the file type restriction, the upload is prevented. **Note:** This
|
|
10475
|
+
* property is not supported by Microsoft Edge.
|
|
10476
|
+
*
|
|
10477
|
+
* Example: `["jpg", "png", "bmp"]`.
|
|
10478
|
+
*/
|
|
10479
|
+
fileType?: string[] | PropertyBindingInfo | `{${string}}`;
|
|
10480
|
+
|
|
10481
|
+
/**
|
|
10482
|
+
* Allows multiple files to be chosen and uploaded from the same folder.
|
|
10483
|
+
*
|
|
10484
|
+
* This property is not supported by Internet Explorer 9.
|
|
10485
|
+
*
|
|
10486
|
+
* **Note:** Keep in mind that the various operating systems for mobile devices can react differently to
|
|
10487
|
+
* the property so that fewer upload functions may be available in some cases.
|
|
10488
|
+
*/
|
|
10489
|
+
multiple?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
10490
|
+
|
|
10491
|
+
/**
|
|
10492
|
+
* A file size limit in megabytes which prevents the upload if at least one file exceeds it.
|
|
10493
|
+
*
|
|
10494
|
+
* This property is not supported by Internet Explorer 9.
|
|
10495
|
+
*/
|
|
10496
|
+
maximumFileSize?: float | PropertyBindingInfo | `{${string}}`;
|
|
10497
|
+
|
|
10498
|
+
/**
|
|
10499
|
+
* The chosen files will be checked against an array of MIME types defined in this property.
|
|
10500
|
+
*
|
|
10501
|
+
* If at least one file does not fit the MIME type restriction, the upload is prevented.
|
|
10502
|
+
*
|
|
10503
|
+
* **Note:** This property is not supported by Internet Explorer. It is only reliable for common file types
|
|
10504
|
+
* like images, audio, video, plain text and HTML documents. File types that are not recognized by the browser
|
|
10505
|
+
* result in `file.type` to be returned as an empty string. In this case the verification could not be performed.
|
|
10506
|
+
* The file upload is not prevented and the validation based on file type is left to the receiving backend
|
|
10507
|
+
* side.
|
|
10508
|
+
*
|
|
10509
|
+
* Example: `["image/png", "image/jpeg"]`.
|
|
10510
|
+
*/
|
|
10511
|
+
mimeType?: string[] | PropertyBindingInfo | `{${string}}`;
|
|
10512
|
+
|
|
10513
|
+
/**
|
|
10514
|
+
* If set to "true", the request will be sent as XHR request instead of a form submit.
|
|
10515
|
+
*
|
|
10516
|
+
* This property is not supported by Internet Explorer 9.
|
|
10517
|
+
*/
|
|
10518
|
+
sendXHR?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
10519
|
+
|
|
10520
|
+
/**
|
|
10521
|
+
* Chosen HTTP request method for file upload.
|
|
10522
|
+
*
|
|
10523
|
+
* @since 1.81.0
|
|
10524
|
+
*/
|
|
10525
|
+
httpRequestMethod?:
|
|
10526
|
+
| FileUploaderHttpRequestMethod
|
|
10527
|
+
| PropertyBindingInfo
|
|
10528
|
+
| `{${string}}`;
|
|
10529
|
+
|
|
10530
|
+
/**
|
|
10531
|
+
* Placeholder for the text field.
|
|
10532
|
+
*/
|
|
10533
|
+
placeholder?: string | PropertyBindingInfo;
|
|
10534
|
+
|
|
10535
|
+
/**
|
|
10536
|
+
* Style of the button.
|
|
10537
|
+
*
|
|
10538
|
+
* Values "Transparent, "Accept", "Reject", or "Emphasized" are allowed.
|
|
10539
|
+
*/
|
|
10540
|
+
style?: string | PropertyBindingInfo;
|
|
10541
|
+
|
|
10542
|
+
/**
|
|
10543
|
+
* If set to "true", the `FileUploader` will be rendered as Button only, without showing the input field.
|
|
10544
|
+
*/
|
|
10545
|
+
buttonOnly?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
10546
|
+
|
|
10547
|
+
/**
|
|
10548
|
+
* If set to "false", the request will be sent as file only request instead of a multipart/form-data request.
|
|
10549
|
+
*
|
|
10550
|
+
* Only one file could be uploaded using this type of request. Required for sending such a request is to
|
|
10551
|
+
* set the property `sendXHR` to "true". This property is not supported by Internet Explorer 9.
|
|
10552
|
+
*/
|
|
10553
|
+
useMultipart?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
10554
|
+
|
|
10555
|
+
/**
|
|
10556
|
+
* The maximum length of a filename which the `FileUploader` will accept.
|
|
10557
|
+
*
|
|
10558
|
+
* If the maximum filename length is exceeded, the corresponding event `filenameLengthExceed` is fired.
|
|
10559
|
+
*
|
|
10560
|
+
* @since 1.24.0
|
|
10561
|
+
*/
|
|
10562
|
+
maximumFilenameLength?: int | PropertyBindingInfo | `{${string}}`;
|
|
10563
|
+
|
|
10564
|
+
/**
|
|
10565
|
+
* Visualizes warnings or errors related to the text field.
|
|
10566
|
+
*
|
|
10567
|
+
* Possible values: Warning, Error, Success, None.
|
|
10568
|
+
*
|
|
10569
|
+
* @since 1.24.0
|
|
10570
|
+
*/
|
|
10571
|
+
valueState?:
|
|
10572
|
+
| (ValueState | keyof typeof ValueState)
|
|
10573
|
+
| PropertyBindingInfo
|
|
10574
|
+
| `{${string}}`;
|
|
10575
|
+
|
|
10576
|
+
/**
|
|
10577
|
+
* Custom text for the value state message pop-up.
|
|
10578
|
+
*
|
|
10579
|
+
* **Note:** If not specified, a default text, based on the value state type, will be used instead.
|
|
10580
|
+
*
|
|
10581
|
+
* @since 1.52
|
|
10582
|
+
*/
|
|
10583
|
+
valueStateText?: string | PropertyBindingInfo;
|
|
10584
|
+
|
|
10585
|
+
/**
|
|
10586
|
+
* Icon to be displayed as graphical element within the button.
|
|
10587
|
+
*
|
|
10588
|
+
* This can be a URI to an image or an icon font URI.
|
|
10589
|
+
*
|
|
10590
|
+
* @since 1.26.0
|
|
10591
|
+
*/
|
|
10592
|
+
icon?: URI | PropertyBindingInfo | `{${string}}`;
|
|
10593
|
+
|
|
10594
|
+
/**
|
|
10595
|
+
* Icon to be displayed as graphical element within the button when it is hovered (only if also a base icon
|
|
10596
|
+
* was specified).
|
|
10597
|
+
*
|
|
10598
|
+
* If not specified, the base icon is used. If an icon font icon is used, this property is ignored.
|
|
10599
|
+
*
|
|
10600
|
+
* @since 1.26.0
|
|
10601
|
+
*/
|
|
10602
|
+
iconHovered?: URI | PropertyBindingInfo | `{${string}}`;
|
|
10603
|
+
|
|
10604
|
+
/**
|
|
10605
|
+
* Icon to be displayed as graphical element within the button when it is selected (only if also a base
|
|
10606
|
+
* icon was specified).
|
|
10607
|
+
*
|
|
10608
|
+
* If not specified, the base or hovered icon is used. If an icon font icon is used, this property is ignored.
|
|
10609
|
+
*
|
|
10610
|
+
* @since 1.26.0
|
|
10611
|
+
*/
|
|
10612
|
+
iconSelected?: URI | PropertyBindingInfo | `{${string}}`;
|
|
10613
|
+
|
|
10614
|
+
/**
|
|
10615
|
+
* If set to true (default), the display sequence is 1. icon 2. control text.
|
|
10616
|
+
*
|
|
10617
|
+
* @since 1.26.0
|
|
10618
|
+
*/
|
|
10619
|
+
iconFirst?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
10620
|
+
|
|
10621
|
+
/**
|
|
10622
|
+
* If set to true, the button is displayed without any text.
|
|
10623
|
+
*
|
|
10624
|
+
* @since 1.26.0
|
|
10625
|
+
*/
|
|
10626
|
+
iconOnly?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
10627
|
+
|
|
10628
|
+
/**
|
|
10629
|
+
* Allows users to upload all files from a given directory and its corresponding subdirectories.
|
|
10630
|
+
*
|
|
10631
|
+
* @since 1.105.0
|
|
10632
|
+
*/
|
|
10633
|
+
directory?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
10634
|
+
|
|
10635
|
+
/**
|
|
10636
|
+
* The parameters for the `FileUploader` which are rendered as a hidden input field.
|
|
10637
|
+
*
|
|
10638
|
+
* @since 1.12.2
|
|
10639
|
+
*/
|
|
10640
|
+
parameters?:
|
|
10641
|
+
| FileUploaderParameter[]
|
|
10642
|
+
| FileUploaderParameter
|
|
10643
|
+
| AggregationBindingInfo
|
|
10644
|
+
| `{${string}}`;
|
|
10645
|
+
|
|
10646
|
+
/**
|
|
10647
|
+
* The header parameters for the `FileUploader` which are only submitted with XHR requests. Header parameters
|
|
10648
|
+
* are not supported by Internet Explorer 9.
|
|
10649
|
+
*/
|
|
10650
|
+
headerParameters?:
|
|
10651
|
+
| FileUploaderParameter[]
|
|
10652
|
+
| FileUploaderParameter
|
|
10653
|
+
| AggregationBindingInfo
|
|
10654
|
+
| `{${string}}`;
|
|
10655
|
+
|
|
10656
|
+
/**
|
|
10657
|
+
* Settings for the `XMLHttpRequest` object. **Note:** This aggregation is only used when the `sendXHR`
|
|
10658
|
+
* property is set to `true`.
|
|
10659
|
+
*
|
|
10660
|
+
* @since 1.52
|
|
10661
|
+
*/
|
|
10662
|
+
xhrSettings?: FileUploaderXHRSettings;
|
|
10663
|
+
|
|
10664
|
+
/**
|
|
10665
|
+
* Association to controls / IDs which describe this control (see WAI-ARIA attribute `aria-describedby`).
|
|
10666
|
+
*/
|
|
10667
|
+
ariaDescribedBy?: Array<Control | string>;
|
|
10668
|
+
|
|
10669
|
+
/**
|
|
10670
|
+
* Association to controls / IDs which label this control (see WAI-ARIA attribute `aria-labelledby`).
|
|
10671
|
+
*/
|
|
10672
|
+
ariaLabelledBy?: Array<Control | string>;
|
|
10673
|
+
|
|
10674
|
+
/**
|
|
10675
|
+
* Event is fired when the value of the file path has been changed.
|
|
10676
|
+
*
|
|
10677
|
+
* **Note:** Keep in mind that because of the HTML input element of type file, the event is also fired in
|
|
10678
|
+
* Chrome browser when the Cancel button of the uploads window is pressed.
|
|
10679
|
+
*/
|
|
10680
|
+
change?: (oEvent: FileUploader$ChangeEvent) => void;
|
|
10681
|
+
|
|
10682
|
+
/**
|
|
10683
|
+
* Event is fired as soon as the upload request is completed (either successful or unsuccessful).
|
|
10684
|
+
*
|
|
10685
|
+
* To see if the upload request was successful, check the `status` parameter for a value 2xx. The actual
|
|
10686
|
+
* progress of the upload can be monitored by listening to the `uploadProgress` event. However, this covers
|
|
10687
|
+
* only the client side of the upload process and does not give any success status from the server.
|
|
10688
|
+
*/
|
|
10689
|
+
uploadComplete?: (oEvent: FileUploader$UploadCompleteEvent) => void;
|
|
10690
|
+
|
|
10691
|
+
/**
|
|
10692
|
+
* Event is fired when the type of a file does not match the `mimeType` or `fileType` property.
|
|
10693
|
+
*/
|
|
10694
|
+
typeMissmatch?: (oEvent: FileUploader$TypeMissmatchEvent) => void;
|
|
10695
|
+
|
|
10696
|
+
/**
|
|
10697
|
+
* Event is fired when the size of a file is above the `maximumFileSize` property. This event is not supported
|
|
10698
|
+
* by Internet Explorer 9 (same restriction as for the property `maximumFileSize`).
|
|
10699
|
+
*/
|
|
10700
|
+
fileSizeExceed?: (oEvent: FileUploader$FileSizeExceedEvent) => void;
|
|
10701
|
+
|
|
7690
10702
|
/**
|
|
7691
|
-
*
|
|
7692
|
-
*
|
|
7693
|
-
* (optional) The additional Text to use for the search help entry.
|
|
7694
|
-
*
|
|
7695
|
-
*
|
|
7696
|
-
* @returns Value of property `searchHelpAdditionalText`
|
|
10703
|
+
* Event is fired when the size of the file is 0
|
|
7697
10704
|
*/
|
|
7698
|
-
|
|
10705
|
+
fileEmpty?: (oEvent: FileUploader$FileEmptyEvent) => void;
|
|
10706
|
+
|
|
7699
10707
|
/**
|
|
7700
|
-
*
|
|
7701
|
-
*
|
|
7702
|
-
* Whether the DropdownBox's search help should be enabled.
|
|
7703
|
-
*
|
|
7704
|
-
* Default value is `false`.
|
|
7705
|
-
*
|
|
7706
|
-
*
|
|
7707
|
-
* @returns Value of property `searchHelpEnabled`
|
|
10708
|
+
* Event is fired when the file is allowed for upload on client side.
|
|
7708
10709
|
*/
|
|
7709
|
-
|
|
10710
|
+
fileAllowed?: (oEvent: Event) => void;
|
|
10711
|
+
|
|
7710
10712
|
/**
|
|
7711
|
-
*
|
|
10713
|
+
* Event is fired after the upload has started and before the upload is completed.
|
|
7712
10714
|
*
|
|
7713
|
-
*
|
|
10715
|
+
* It contains progress information related to the running upload. Depending on file size, band width and
|
|
10716
|
+
* used browser the event is fired once or multiple times.
|
|
7714
10717
|
*
|
|
10718
|
+
* This event is only supported with property `sendXHR` set to true, i.e. the event is not supported in
|
|
10719
|
+
* Internet Explorer 9.
|
|
7715
10720
|
*
|
|
7716
|
-
* @
|
|
10721
|
+
* @since 1.24.0
|
|
7717
10722
|
*/
|
|
7718
|
-
|
|
10723
|
+
uploadProgress?: (oEvent: FileUploader$UploadProgressEvent) => void;
|
|
10724
|
+
|
|
7719
10725
|
/**
|
|
7720
|
-
*
|
|
7721
|
-
*
|
|
7722
|
-
* (optional) The text to use for the search help entry.
|
|
10726
|
+
* Event is fired after the current upload has been aborted.
|
|
7723
10727
|
*
|
|
10728
|
+
* This event is only supported with property `sendXHR` set to true, i.e. the event is not supported in
|
|
10729
|
+
* Internet Explorer 9.
|
|
7724
10730
|
*
|
|
7725
|
-
* @
|
|
10731
|
+
* @since 1.24.0
|
|
7726
10732
|
*/
|
|
7727
|
-
|
|
10733
|
+
uploadAborted?: (oEvent: FileUploader$UploadAbortedEvent) => void;
|
|
10734
|
+
|
|
7728
10735
|
/**
|
|
7729
|
-
*
|
|
7730
|
-
*
|
|
10736
|
+
* Event is fired, if the filename of a chosen file is longer than the value specified with the `maximumFilenameLength`
|
|
10737
|
+
* property.
|
|
7731
10738
|
*
|
|
7732
|
-
*
|
|
7733
|
-
* @returns string tooltip or `undefined`
|
|
10739
|
+
* @since 1.24.0
|
|
7734
10740
|
*/
|
|
7735
|
-
|
|
10741
|
+
filenameLengthExceed?: (
|
|
10742
|
+
oEvent: FileUploader$FilenameLengthExceedEvent
|
|
10743
|
+
) => void;
|
|
10744
|
+
|
|
7736
10745
|
/**
|
|
7737
|
-
*
|
|
10746
|
+
* Event is fired before an upload is started.
|
|
7738
10747
|
*
|
|
7739
|
-
* @
|
|
10748
|
+
* @since 1.30.0
|
|
7740
10749
|
*/
|
|
7741
|
-
|
|
7742
|
-
|
|
7743
|
-
* The event object.
|
|
7744
|
-
*/
|
|
7745
|
-
oEvent: jQuery.Event
|
|
7746
|
-
): void;
|
|
10750
|
+
uploadStart?: (oEvent: FileUploader$UploadStartEvent) => void;
|
|
10751
|
+
|
|
7747
10752
|
/**
|
|
7748
|
-
*
|
|
10753
|
+
* Fired before select file dialog opens.
|
|
7749
10754
|
*
|
|
7750
|
-
* @
|
|
10755
|
+
* @since 1.102.0
|
|
7751
10756
|
*/
|
|
7752
|
-
|
|
7753
|
-
|
|
7754
|
-
* The event object.
|
|
7755
|
-
*/
|
|
7756
|
-
oEvent: jQuery.Event
|
|
7757
|
-
): void;
|
|
10757
|
+
beforeDialogOpen?: (oEvent: Event) => void;
|
|
10758
|
+
|
|
7758
10759
|
/**
|
|
7759
|
-
*
|
|
10760
|
+
* Fired after select file dialog closes.
|
|
7760
10761
|
*
|
|
7761
|
-
* @
|
|
10762
|
+
* @since 1.102.0
|
|
7762
10763
|
*/
|
|
7763
|
-
|
|
7764
|
-
|
|
7765
|
-
|
|
7766
|
-
|
|
7767
|
-
|
|
7768
|
-
|
|
10764
|
+
afterDialogClose?: (oEvent: Event) => void;
|
|
10765
|
+
}
|
|
10766
|
+
|
|
10767
|
+
/**
|
|
10768
|
+
* Parameters of the FileUploader#afterDialogClose event.
|
|
10769
|
+
*/
|
|
10770
|
+
export interface FileUploader$AfterDialogCloseEventParameters {}
|
|
10771
|
+
|
|
10772
|
+
/**
|
|
10773
|
+
* Event object of the FileUploader#afterDialogClose event.
|
|
10774
|
+
*/
|
|
10775
|
+
export type FileUploader$AfterDialogCloseEvent = Event<
|
|
10776
|
+
FileUploader$AfterDialogCloseEventParameters,
|
|
10777
|
+
FileUploader
|
|
10778
|
+
>;
|
|
10779
|
+
|
|
10780
|
+
/**
|
|
10781
|
+
* Parameters of the FileUploader#beforeDialogOpen event.
|
|
10782
|
+
*/
|
|
10783
|
+
export interface FileUploader$BeforeDialogOpenEventParameters {}
|
|
10784
|
+
|
|
10785
|
+
/**
|
|
10786
|
+
* Event object of the FileUploader#beforeDialogOpen event.
|
|
10787
|
+
*/
|
|
10788
|
+
export type FileUploader$BeforeDialogOpenEvent = Event<
|
|
10789
|
+
FileUploader$BeforeDialogOpenEventParameters,
|
|
10790
|
+
FileUploader
|
|
10791
|
+
>;
|
|
10792
|
+
|
|
10793
|
+
/**
|
|
10794
|
+
* Parameters of the FileUploader#change event.
|
|
10795
|
+
*/
|
|
10796
|
+
export interface FileUploader$ChangeEventParameters {
|
|
7769
10797
|
/**
|
|
7770
|
-
*
|
|
7771
|
-
*
|
|
7772
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
10798
|
+
* New file path value.
|
|
7773
10799
|
*/
|
|
7774
|
-
|
|
7775
|
-
|
|
7776
|
-
* the occuring event
|
|
7777
|
-
*/
|
|
7778
|
-
oEvent: jQuery.Event
|
|
7779
|
-
): void;
|
|
10800
|
+
newValue?: string;
|
|
10801
|
+
|
|
7780
10802
|
/**
|
|
7781
|
-
*
|
|
7782
|
-
*
|
|
7783
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
10803
|
+
* Files.
|
|
7784
10804
|
*/
|
|
7785
|
-
|
|
7786
|
-
|
|
7787
|
-
|
|
7788
|
-
|
|
7789
|
-
|
|
7790
|
-
|
|
10805
|
+
files?: object[];
|
|
10806
|
+
}
|
|
10807
|
+
|
|
10808
|
+
/**
|
|
10809
|
+
* Event object of the FileUploader#change event.
|
|
10810
|
+
*/
|
|
10811
|
+
export type FileUploader$ChangeEvent = Event<
|
|
10812
|
+
FileUploader$ChangeEventParameters,
|
|
10813
|
+
FileUploader
|
|
10814
|
+
>;
|
|
10815
|
+
|
|
10816
|
+
/**
|
|
10817
|
+
* Parameters of the FileUploader#fileAllowed event.
|
|
10818
|
+
*/
|
|
10819
|
+
export interface FileUploader$FileAllowedEventParameters {}
|
|
10820
|
+
|
|
10821
|
+
/**
|
|
10822
|
+
* Event object of the FileUploader#fileAllowed event.
|
|
10823
|
+
*/
|
|
10824
|
+
export type FileUploader$FileAllowedEvent = Event<
|
|
10825
|
+
FileUploader$FileAllowedEventParameters,
|
|
10826
|
+
FileUploader
|
|
10827
|
+
>;
|
|
10828
|
+
|
|
10829
|
+
/**
|
|
10830
|
+
* Parameters of the FileUploader#fileEmpty event.
|
|
10831
|
+
*/
|
|
10832
|
+
export interface FileUploader$FileEmptyEventParameters {
|
|
7791
10833
|
/**
|
|
7792
|
-
*
|
|
7793
|
-
* case there is a keyup with a tab this results from being entered via tabbing and can be ignored, too.
|
|
7794
|
-
*
|
|
7795
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
10834
|
+
* The name of the file to be uploaded.
|
|
7796
10835
|
*/
|
|
7797
|
-
|
|
7798
|
-
|
|
7799
|
-
|
|
7800
|
-
|
|
7801
|
-
|
|
7802
|
-
|
|
10836
|
+
fileName?: string;
|
|
10837
|
+
}
|
|
10838
|
+
|
|
10839
|
+
/**
|
|
10840
|
+
* Event object of the FileUploader#fileEmpty event.
|
|
10841
|
+
*/
|
|
10842
|
+
export type FileUploader$FileEmptyEvent = Event<
|
|
10843
|
+
FileUploader$FileEmptyEventParameters,
|
|
10844
|
+
FileUploader
|
|
10845
|
+
>;
|
|
10846
|
+
|
|
10847
|
+
/**
|
|
10848
|
+
* Parameters of the FileUploader#filenameLengthExceed event.
|
|
10849
|
+
*/
|
|
10850
|
+
export interface FileUploader$FilenameLengthExceedEventParameters {
|
|
7803
10851
|
/**
|
|
7804
|
-
*
|
|
7805
|
-
*
|
|
7806
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
10852
|
+
* The filename, which is longer than specified by the value of the property `maximumFilenameLength`.
|
|
7807
10853
|
*/
|
|
7808
|
-
|
|
7809
|
-
|
|
7810
|
-
|
|
7811
|
-
|
|
7812
|
-
|
|
7813
|
-
|
|
10854
|
+
fileName?: string;
|
|
10855
|
+
}
|
|
10856
|
+
|
|
10857
|
+
/**
|
|
10858
|
+
* Event object of the FileUploader#filenameLengthExceed event.
|
|
10859
|
+
*/
|
|
10860
|
+
export type FileUploader$FilenameLengthExceedEvent = Event<
|
|
10861
|
+
FileUploader$FilenameLengthExceedEventParameters,
|
|
10862
|
+
FileUploader
|
|
10863
|
+
>;
|
|
10864
|
+
|
|
10865
|
+
/**
|
|
10866
|
+
* Parameters of the FileUploader#fileSizeExceed event.
|
|
10867
|
+
*/
|
|
10868
|
+
export interface FileUploader$FileSizeExceedEventParameters {
|
|
7814
10869
|
/**
|
|
7815
|
-
*
|
|
7816
|
-
* feature, removes the selected item from this instance's history.
|
|
7817
|
-
*
|
|
7818
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
10870
|
+
* The name of a file to be uploaded.
|
|
7819
10871
|
*/
|
|
7820
|
-
|
|
7821
|
-
|
|
7822
|
-
* the occuring event
|
|
7823
|
-
*/
|
|
7824
|
-
oEvent: jQuery.Event
|
|
7825
|
-
): void;
|
|
10872
|
+
fileName?: string;
|
|
10873
|
+
|
|
7826
10874
|
/**
|
|
7827
|
-
*
|
|
7828
|
-
*
|
|
7829
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
10875
|
+
* The size in MB of a file to be uploaded.
|
|
7830
10876
|
*/
|
|
7831
|
-
|
|
7832
|
-
|
|
7833
|
-
|
|
7834
|
-
|
|
7835
|
-
|
|
7836
|
-
|
|
10877
|
+
fileSize?: string;
|
|
10878
|
+
}
|
|
10879
|
+
|
|
10880
|
+
/**
|
|
10881
|
+
* Event object of the FileUploader#fileSizeExceed event.
|
|
10882
|
+
*/
|
|
10883
|
+
export type FileUploader$FileSizeExceedEvent = Event<
|
|
10884
|
+
FileUploader$FileSizeExceedEventParameters,
|
|
10885
|
+
FileUploader
|
|
10886
|
+
>;
|
|
10887
|
+
|
|
10888
|
+
/**
|
|
10889
|
+
* Parameters of the FileUploader#typeMissmatch event.
|
|
10890
|
+
*/
|
|
10891
|
+
export interface FileUploader$TypeMissmatchEventParameters {
|
|
7837
10892
|
/**
|
|
7838
|
-
*
|
|
7839
|
-
*
|
|
7840
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
10893
|
+
* The name of a file to be uploaded.
|
|
7841
10894
|
*/
|
|
7842
|
-
|
|
7843
|
-
|
|
7844
|
-
* The event object.
|
|
7845
|
-
*/
|
|
7846
|
-
oEvent: jQuery.Event
|
|
7847
|
-
): void;
|
|
10895
|
+
fileName?: string;
|
|
10896
|
+
|
|
7848
10897
|
/**
|
|
7849
|
-
*
|
|
7850
|
-
*
|
|
7851
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
10898
|
+
* The file ending of a file to be uploaded.
|
|
7852
10899
|
*/
|
|
7853
|
-
|
|
7854
|
-
|
|
7855
|
-
* The event object.
|
|
7856
|
-
*/
|
|
7857
|
-
oEvent: jQuery.Event
|
|
7858
|
-
): void;
|
|
10900
|
+
fileType?: string;
|
|
10901
|
+
|
|
7859
10902
|
/**
|
|
7860
|
-
*
|
|
7861
|
-
*
|
|
7862
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
10903
|
+
* The MIME type of a file to be uploaded.
|
|
7863
10904
|
*/
|
|
7864
|
-
|
|
7865
|
-
|
|
7866
|
-
|
|
7867
|
-
|
|
7868
|
-
|
|
7869
|
-
|
|
10905
|
+
mimeType?: string;
|
|
10906
|
+
}
|
|
10907
|
+
|
|
10908
|
+
/**
|
|
10909
|
+
* Event object of the FileUploader#typeMissmatch event.
|
|
10910
|
+
*/
|
|
10911
|
+
export type FileUploader$TypeMissmatchEvent = Event<
|
|
10912
|
+
FileUploader$TypeMissmatchEventParameters,
|
|
10913
|
+
FileUploader
|
|
10914
|
+
>;
|
|
10915
|
+
|
|
10916
|
+
/**
|
|
10917
|
+
* Parameters of the FileUploader#uploadAborted event.
|
|
10918
|
+
*/
|
|
10919
|
+
export interface FileUploader$UploadAbortedEventParameters {
|
|
7870
10920
|
/**
|
|
7871
|
-
*
|
|
7872
|
-
*
|
|
7873
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
10921
|
+
* The name of a file to be uploaded.
|
|
7874
10922
|
*/
|
|
7875
|
-
|
|
7876
|
-
|
|
7877
|
-
* The event object.
|
|
7878
|
-
*/
|
|
7879
|
-
oEvent: jQuery.Event
|
|
7880
|
-
): void;
|
|
10923
|
+
fileName?: string;
|
|
10924
|
+
|
|
7881
10925
|
/**
|
|
7882
|
-
*
|
|
7883
|
-
*
|
|
7884
|
-
* Maximum number of history items in the list.
|
|
7885
|
-
*
|
|
7886
|
-
* If 0 no history is displayed or stored. The history is locally stored on the client. Therefore do not
|
|
7887
|
-
* activate this feature when this control handles confidential data.
|
|
7888
|
-
*
|
|
7889
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7890
|
-
*
|
|
7891
|
-
* Default value is `0`.
|
|
7892
|
-
*
|
|
10926
|
+
* Http-Request-Headers.
|
|
7893
10927
|
*
|
|
7894
|
-
*
|
|
10928
|
+
* Required for receiving `requestHeader` is to set the property `sendXHR` to true. This property is not
|
|
10929
|
+
* supported by Internet Explorer 9.
|
|
7895
10930
|
*/
|
|
7896
|
-
|
|
7897
|
-
|
|
7898
|
-
|
|
7899
|
-
|
|
7900
|
-
|
|
7901
|
-
|
|
10931
|
+
requestHeaders?: object[];
|
|
10932
|
+
}
|
|
10933
|
+
|
|
10934
|
+
/**
|
|
10935
|
+
* Event object of the FileUploader#uploadAborted event.
|
|
10936
|
+
*/
|
|
10937
|
+
export type FileUploader$UploadAbortedEvent = Event<
|
|
10938
|
+
FileUploader$UploadAbortedEventParameters,
|
|
10939
|
+
FileUploader
|
|
10940
|
+
>;
|
|
10941
|
+
|
|
10942
|
+
/**
|
|
10943
|
+
* Parameters of the FileUploader#uploadComplete event.
|
|
10944
|
+
*/
|
|
10945
|
+
export interface FileUploader$UploadCompleteEventParameters {
|
|
7902
10946
|
/**
|
|
7903
|
-
*
|
|
7904
|
-
*
|
|
7905
|
-
* Default value is empty/`undefined`
|
|
7906
|
-
*
|
|
7907
|
-
*
|
|
7908
|
-
* @returns `this` to allow method chaining
|
|
10947
|
+
* The name of a file to be uploaded.
|
|
7909
10948
|
*/
|
|
7910
|
-
|
|
7911
|
-
|
|
7912
|
-
* new value for property `searchHelpAdditionalText`
|
|
7913
|
-
*/
|
|
7914
|
-
sSearchHelpAdditionalText: string
|
|
7915
|
-
): this;
|
|
10949
|
+
fileName?: string;
|
|
10950
|
+
|
|
7916
10951
|
/**
|
|
7917
|
-
*
|
|
7918
|
-
* compatiple with the previous functionality
|
|
7919
|
-
*
|
|
7920
|
-
* Default value is `false`
|
|
10952
|
+
* Response message which comes from the server.
|
|
7921
10953
|
*
|
|
10954
|
+
* On the server side this response has to be put within the "body" tags of the response document
|
|
10955
|
+
* of the iFrame. It can consist of a return code and an optional message. This does not work in cross-domain
|
|
10956
|
+
* scenarios.
|
|
10957
|
+
*/
|
|
10958
|
+
response?: string;
|
|
10959
|
+
|
|
10960
|
+
/**
|
|
10961
|
+
* ReadyState of the XHR request.
|
|
7922
10962
|
*
|
|
7923
|
-
*
|
|
10963
|
+
* Required for receiving a `readyStateXHR` is to set the property `sendXHR` to true. This property is not
|
|
10964
|
+
* supported by Internet Explorer 9.
|
|
7924
10965
|
*/
|
|
7925
|
-
|
|
7926
|
-
|
|
7927
|
-
* new value for property `searchHelpEnabled`
|
|
7928
|
-
*/
|
|
7929
|
-
bEnabled: boolean,
|
|
7930
|
-
/**
|
|
7931
|
-
* new value for property `searchHelpText`
|
|
7932
|
-
*/
|
|
7933
|
-
sText: string,
|
|
7934
|
-
/**
|
|
7935
|
-
* new value for property `searchHelpAdditionalText`
|
|
7936
|
-
*/
|
|
7937
|
-
sAdditionalText: string,
|
|
7938
|
-
/**
|
|
7939
|
-
* new value for property `searchHelpIcon`
|
|
7940
|
-
*/
|
|
7941
|
-
sIcon: string
|
|
7942
|
-
): this;
|
|
10966
|
+
readyStateXHR?: string;
|
|
10967
|
+
|
|
7943
10968
|
/**
|
|
7944
|
-
*
|
|
10969
|
+
* Status of the XHR request.
|
|
7945
10970
|
*
|
|
7946
|
-
*
|
|
10971
|
+
* Required for receiving a `status` is to set the property `sendXHR` to true. This property is not supported
|
|
10972
|
+
* by Internet Explorer 9.
|
|
10973
|
+
*/
|
|
10974
|
+
status?: int;
|
|
10975
|
+
|
|
10976
|
+
/**
|
|
10977
|
+
* Http-Response which comes from the server.
|
|
7947
10978
|
*
|
|
10979
|
+
* Required for receiving `responseRaw` is to set the property `sendXHR` to true.
|
|
7948
10980
|
*
|
|
7949
|
-
*
|
|
10981
|
+
* This property is not supported by Internet Explorer 9.
|
|
7950
10982
|
*/
|
|
7951
|
-
|
|
7952
|
-
|
|
7953
|
-
* new value for property `searchHelpIcon`
|
|
7954
|
-
*/
|
|
7955
|
-
sSearchHelpIcon: URI
|
|
7956
|
-
): this;
|
|
10983
|
+
responseRaw?: string;
|
|
10984
|
+
|
|
7957
10985
|
/**
|
|
7958
|
-
*
|
|
10986
|
+
* Http-Response-Headers which come from the server.
|
|
7959
10987
|
*
|
|
7960
|
-
*
|
|
10988
|
+
* Provided as a JSON-map, i.e. each header-field is reflected by a property in the `headers` object, with
|
|
10989
|
+
* the property value reflecting the header-field's content.
|
|
7961
10990
|
*
|
|
10991
|
+
* Required for receiving `headers` is to set the property `sendXHR` to true. This property is not supported
|
|
10992
|
+
* by Internet Explorer 9.
|
|
10993
|
+
*/
|
|
10994
|
+
headers?: object;
|
|
10995
|
+
|
|
10996
|
+
/**
|
|
10997
|
+
* Http-Request-Headers.
|
|
7962
10998
|
*
|
|
7963
|
-
*
|
|
10999
|
+
* Required for receiving `requestHeaders` is to set the property `sendXHR` to true. This property is not
|
|
11000
|
+
* supported by Internet Explorer 9.
|
|
7964
11001
|
*/
|
|
7965
|
-
|
|
7966
|
-
/**
|
|
7967
|
-
* new value for property `searchHelpText`
|
|
7968
|
-
*/
|
|
7969
|
-
sSearchHelpText: string
|
|
7970
|
-
): this;
|
|
11002
|
+
requestHeaders?: object[];
|
|
7971
11003
|
}
|
|
11004
|
+
|
|
7972
11005
|
/**
|
|
7973
|
-
*
|
|
7974
|
-
*
|
|
7975
|
-
* @deprecated As of version 1.38. replaced by {@link sap.m.ComboBox}
|
|
11006
|
+
* Event object of the FileUploader#uploadComplete event.
|
|
7976
11007
|
*/
|
|
7977
|
-
export
|
|
7978
|
-
|
|
7979
|
-
|
|
7980
|
-
|
|
7981
|
-
searchHelpEnabled?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
11008
|
+
export type FileUploader$UploadCompleteEvent = Event<
|
|
11009
|
+
FileUploader$UploadCompleteEventParameters,
|
|
11010
|
+
FileUploader
|
|
11011
|
+
>;
|
|
7982
11012
|
|
|
11013
|
+
/**
|
|
11014
|
+
* Parameters of the FileUploader#uploadProgress event.
|
|
11015
|
+
*/
|
|
11016
|
+
export interface FileUploader$UploadProgressEventParameters {
|
|
7983
11017
|
/**
|
|
7984
|
-
*
|
|
11018
|
+
* Indicates whether or not the relative upload progress can be calculated out of loaded and total.
|
|
7985
11019
|
*/
|
|
7986
|
-
|
|
11020
|
+
lengthComputable?: boolean;
|
|
7987
11021
|
|
|
7988
11022
|
/**
|
|
7989
|
-
*
|
|
11023
|
+
* The number of bytes of the file which have been uploaded by the time the event was fired.
|
|
7990
11024
|
*/
|
|
7991
|
-
|
|
11025
|
+
loaded?: float;
|
|
7992
11026
|
|
|
7993
11027
|
/**
|
|
7994
|
-
*
|
|
11028
|
+
* The total size of the file to be uploaded in bytes.
|
|
7995
11029
|
*/
|
|
7996
|
-
|
|
11030
|
+
total?: float;
|
|
7997
11031
|
|
|
7998
11032
|
/**
|
|
7999
|
-
*
|
|
8000
|
-
*
|
|
8001
|
-
* If 0 no history is displayed or stored. The history is locally stored on the client. Therefore do not
|
|
8002
|
-
* activate this feature when this control handles confidential data.
|
|
11033
|
+
* The name of a file to be uploaded.
|
|
8003
11034
|
*/
|
|
8004
|
-
|
|
11035
|
+
fileName?: string;
|
|
8005
11036
|
|
|
8006
11037
|
/**
|
|
8007
|
-
*
|
|
8008
|
-
*
|
|
11038
|
+
* Http-Request-Headers.
|
|
11039
|
+
*
|
|
11040
|
+
* Required for receiving `requestHeaders` is to set the property `sendXHR` to true. This property is not
|
|
11041
|
+
* supported by Internet Explorer 9.
|
|
8009
11042
|
*/
|
|
8010
|
-
|
|
11043
|
+
requestHeaders?: object[];
|
|
8011
11044
|
}
|
|
8012
11045
|
|
|
8013
11046
|
/**
|
|
8014
|
-
*
|
|
11047
|
+
* Event object of the FileUploader#uploadProgress event.
|
|
8015
11048
|
*/
|
|
8016
|
-
export
|
|
11049
|
+
export type FileUploader$UploadProgressEvent = Event<
|
|
11050
|
+
FileUploader$UploadProgressEventParameters,
|
|
11051
|
+
FileUploader
|
|
11052
|
+
>;
|
|
11053
|
+
|
|
11054
|
+
/**
|
|
11055
|
+
* Parameters of the FileUploader#uploadStart event.
|
|
11056
|
+
*/
|
|
11057
|
+
export interface FileUploader$UploadStartEventParameters {
|
|
8017
11058
|
/**
|
|
8018
|
-
* The
|
|
11059
|
+
* The name of a file to be uploaded.
|
|
8019
11060
|
*/
|
|
8020
|
-
|
|
11061
|
+
fileName?: string;
|
|
11062
|
+
|
|
11063
|
+
/**
|
|
11064
|
+
* Http-Request-Headers.
|
|
11065
|
+
*
|
|
11066
|
+
* Required for receiving `requestHeaders` is to set the property `sendXHR` to true. This property is not
|
|
11067
|
+
* supported by Internet Explorer 9.
|
|
11068
|
+
*/
|
|
11069
|
+
requestHeaders?: object[];
|
|
8021
11070
|
}
|
|
8022
11071
|
|
|
8023
11072
|
/**
|
|
8024
|
-
* Event object of the
|
|
11073
|
+
* Event object of the FileUploader#uploadStart event.
|
|
8025
11074
|
*/
|
|
8026
|
-
export type
|
|
8027
|
-
|
|
8028
|
-
|
|
11075
|
+
export type FileUploader$UploadStartEvent = Event<
|
|
11076
|
+
FileUploader$UploadStartEventParameters,
|
|
11077
|
+
FileUploader
|
|
8029
11078
|
>;
|
|
8030
11079
|
}
|
|
8031
11080
|
|
|
8032
|
-
declare module "sap/ui/commons/
|
|
8033
|
-
|
|
8034
|
-
|
|
8035
|
-
|
|
8036
|
-
|
|
11081
|
+
declare module "sap/ui/commons/FileUploaderHttpRequestMethod" {
|
|
11082
|
+
/**
|
|
11083
|
+
* Types of HTTP request methods.
|
|
11084
|
+
*
|
|
11085
|
+
* @since 1.144.0
|
|
11086
|
+
* @deprecated As of version 1.144.0. Please use the control sap.ui.unified.FileUploaderHttpRequestMethod
|
|
11087
|
+
* of the library sap.ui.unified instead.
|
|
11088
|
+
*/
|
|
11089
|
+
enum FileUploaderHttpRequestMethod {
|
|
11090
|
+
/**
|
|
11091
|
+
* HTTP request POST method.
|
|
11092
|
+
*/
|
|
11093
|
+
Post = "POST",
|
|
11094
|
+
/**
|
|
11095
|
+
* HTTP request PUT method.
|
|
11096
|
+
*/
|
|
11097
|
+
Put = "PUT",
|
|
11098
|
+
}
|
|
11099
|
+
export default FileUploaderHttpRequestMethod;
|
|
11100
|
+
}
|
|
11101
|
+
|
|
11102
|
+
declare module "sap/ui/commons/FileUploaderParameter" {
|
|
11103
|
+
import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
|
|
8037
11104
|
|
|
8038
11105
|
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
8039
11106
|
|
|
11107
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
11108
|
+
|
|
8040
11109
|
/**
|
|
8041
|
-
*
|
|
8042
|
-
* such as on change uploads (the upload starts immediately after a file has been selected), file uploads
|
|
8043
|
-
* with explicit calls, adjustable control sizes, text display after uploads, or tooltips containing complete
|
|
8044
|
-
* file paths.
|
|
11110
|
+
* Represents a parameter for the FileUploader which is rendered as a hidden inputfield.
|
|
8045
11111
|
*
|
|
8046
|
-
* @deprecated As of version 1.21.0. Please use the control sap.ui.unified.
|
|
8047
|
-
* instead.
|
|
11112
|
+
* @deprecated As of version 1.21.0. Please use the control sap.ui.unified.FileUploaderParameter of the
|
|
11113
|
+
* library sap.ui.unified instead.
|
|
8048
11114
|
*/
|
|
8049
|
-
export default class
|
|
11115
|
+
export default class FileUploaderParameter extends UI5Element {
|
|
8050
11116
|
/**
|
|
8051
|
-
* Constructor for a new
|
|
11117
|
+
* Constructor for a new FileUploaderParameter.
|
|
8052
11118
|
*
|
|
8053
11119
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
8054
11120
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
8055
11121
|
* of the syntax of the settings object.
|
|
8056
|
-
*
|
|
8057
|
-
* This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.unified.FileUploader#constructor sap.ui.unified.FileUploader }
|
|
8058
|
-
* can be used.
|
|
8059
11122
|
*/
|
|
8060
11123
|
constructor(
|
|
8061
11124
|
/**
|
|
8062
11125
|
* initial settings for the new control
|
|
8063
11126
|
*/
|
|
8064
|
-
mSettings?: $
|
|
11127
|
+
mSettings?: $FileUploaderParameterSettings
|
|
8065
11128
|
);
|
|
8066
11129
|
/**
|
|
8067
|
-
* Constructor for a new
|
|
11130
|
+
* Constructor for a new FileUploaderParameter.
|
|
8068
11131
|
*
|
|
8069
11132
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
8070
11133
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
8071
11134
|
* of the syntax of the settings object.
|
|
8072
|
-
*
|
|
8073
|
-
* This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.unified.FileUploader#constructor sap.ui.unified.FileUploader }
|
|
8074
|
-
* can be used.
|
|
8075
11135
|
*/
|
|
8076
11136
|
constructor(
|
|
8077
11137
|
/**
|
|
@@ -8081,14 +11141,14 @@ declare module "sap/ui/commons/FileUploader" {
|
|
|
8081
11141
|
/**
|
|
8082
11142
|
* initial settings for the new control
|
|
8083
11143
|
*/
|
|
8084
|
-
mSettings?: $
|
|
11144
|
+
mSettings?: $FileUploaderParameterSettings
|
|
8085
11145
|
);
|
|
8086
11146
|
|
|
8087
11147
|
/**
|
|
8088
|
-
* Creates a new subclass of class sap.ui.commons.
|
|
8089
|
-
* the information contained in `oClassInfo`.
|
|
11148
|
+
* Creates a new subclass of class sap.ui.commons.FileUploaderParameter with name `sClassName` and enriches
|
|
11149
|
+
* it with the information contained in `oClassInfo`.
|
|
8090
11150
|
*
|
|
8091
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.
|
|
11151
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
8092
11152
|
*
|
|
8093
11153
|
*
|
|
8094
11154
|
* @returns Created class / constructor function
|
|
@@ -8101,7 +11161,7 @@ declare module "sap/ui/commons/FileUploader" {
|
|
|
8101
11161
|
/**
|
|
8102
11162
|
* Object literal with information about the class
|
|
8103
11163
|
*/
|
|
8104
|
-
oClassInfo?: sap.ClassInfo<T,
|
|
11164
|
+
oClassInfo?: sap.ClassInfo<T, FileUploaderParameter>,
|
|
8105
11165
|
/**
|
|
8106
11166
|
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
8107
11167
|
* used by this class
|
|
@@ -8109,62 +11169,124 @@ declare module "sap/ui/commons/FileUploader" {
|
|
|
8109
11169
|
FNMetaImpl?: Function
|
|
8110
11170
|
): Function;
|
|
8111
11171
|
/**
|
|
8112
|
-
* Returns a metadata object for class sap.ui.commons.
|
|
11172
|
+
* Returns a metadata object for class sap.ui.commons.FileUploaderParameter.
|
|
8113
11173
|
*
|
|
8114
11174
|
*
|
|
8115
11175
|
* @returns Metadata object describing this class
|
|
8116
11176
|
*/
|
|
8117
11177
|
static getMetadata(): ElementMetadata;
|
|
11178
|
+
/**
|
|
11179
|
+
* Gets current value of property {@link #getName name}.
|
|
11180
|
+
*
|
|
11181
|
+
* The name of the hidden inputfield.
|
|
11182
|
+
*
|
|
11183
|
+
* @since 1.12.2
|
|
11184
|
+
*
|
|
11185
|
+
* @returns Value of property `name`
|
|
11186
|
+
*/
|
|
11187
|
+
getName(): string;
|
|
11188
|
+
/**
|
|
11189
|
+
* Gets current value of property {@link #getValue value}.
|
|
11190
|
+
*
|
|
11191
|
+
* The value of the hidden inputfield.
|
|
11192
|
+
*
|
|
11193
|
+
* @since 1.12.2
|
|
11194
|
+
*
|
|
11195
|
+
* @returns Value of property `value`
|
|
11196
|
+
*/
|
|
11197
|
+
getValue(): string;
|
|
11198
|
+
/**
|
|
11199
|
+
* Sets a new value for property {@link #getName name}.
|
|
11200
|
+
*
|
|
11201
|
+
* The name of the hidden inputfield.
|
|
11202
|
+
*
|
|
11203
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
11204
|
+
*
|
|
11205
|
+
* @since 1.12.2
|
|
11206
|
+
*
|
|
11207
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11208
|
+
*/
|
|
11209
|
+
setName(
|
|
11210
|
+
/**
|
|
11211
|
+
* New value for property `name`
|
|
11212
|
+
*/
|
|
11213
|
+
sName?: string
|
|
11214
|
+
): this;
|
|
11215
|
+
/**
|
|
11216
|
+
* Sets a new value for property {@link #getValue value}.
|
|
11217
|
+
*
|
|
11218
|
+
* The value of the hidden inputfield.
|
|
11219
|
+
*
|
|
11220
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
11221
|
+
*
|
|
11222
|
+
* @since 1.12.2
|
|
11223
|
+
*
|
|
11224
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11225
|
+
*/
|
|
11226
|
+
setValue(
|
|
11227
|
+
/**
|
|
11228
|
+
* New value for property `value`
|
|
11229
|
+
*/
|
|
11230
|
+
sValue?: string
|
|
11231
|
+
): this;
|
|
8118
11232
|
}
|
|
8119
11233
|
/**
|
|
8120
|
-
* Describes the settings that can be provided to the
|
|
11234
|
+
* Describes the settings that can be provided to the FileUploaderParameter constructor.
|
|
8121
11235
|
*
|
|
8122
|
-
* @deprecated As of version 1.21.0. Please use the control sap.ui.unified.
|
|
8123
|
-
* instead.
|
|
11236
|
+
* @deprecated As of version 1.21.0. Please use the control sap.ui.unified.FileUploaderParameter of the
|
|
11237
|
+
* library sap.ui.unified instead.
|
|
8124
11238
|
*/
|
|
8125
|
-
export interface $
|
|
11239
|
+
export interface $FileUploaderParameterSettings extends $ElementSettings {
|
|
11240
|
+
/**
|
|
11241
|
+
* The name of the hidden inputfield.
|
|
11242
|
+
*
|
|
11243
|
+
* @since 1.12.2
|
|
11244
|
+
*/
|
|
11245
|
+
name?: string | PropertyBindingInfo;
|
|
11246
|
+
|
|
11247
|
+
/**
|
|
11248
|
+
* The value of the hidden inputfield.
|
|
11249
|
+
*
|
|
11250
|
+
* @since 1.12.2
|
|
11251
|
+
*/
|
|
11252
|
+
value?: string | PropertyBindingInfo;
|
|
11253
|
+
}
|
|
8126
11254
|
}
|
|
8127
11255
|
|
|
8128
|
-
declare module "sap/ui/commons/
|
|
8129
|
-
import {
|
|
8130
|
-
default as FileUploaderParameter1,
|
|
8131
|
-
$FileUploaderParameterSettings as $FileUploaderParameterSettings1,
|
|
8132
|
-
} from "sap/ui/unified/FileUploaderParameter";
|
|
11256
|
+
declare module "sap/ui/commons/FileUploaderXHRSettings" {
|
|
11257
|
+
import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
|
|
8133
11258
|
|
|
8134
11259
|
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
8135
11260
|
|
|
11261
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
11262
|
+
|
|
8136
11263
|
/**
|
|
8137
|
-
*
|
|
11264
|
+
* Properties for the `XMLHttpRequest` object used for file uploads.
|
|
8138
11265
|
*
|
|
8139
|
-
* @
|
|
11266
|
+
* @since 1.144
|
|
11267
|
+
* @deprecated As of version 1.144.0. Please use the control sap.ui.unified.FileUploaderXHRSettings of the
|
|
8140
11268
|
* library sap.ui.unified instead.
|
|
8141
11269
|
*/
|
|
8142
|
-
export default class
|
|
11270
|
+
export default class FileUploaderXHRSettings extends UI5Element {
|
|
8143
11271
|
/**
|
|
8144
|
-
* Constructor for a new
|
|
11272
|
+
* Constructor for a new FileUploaderXHRSettings.
|
|
8145
11273
|
*
|
|
8146
11274
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
8147
11275
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
8148
11276
|
* of the syntax of the settings object.
|
|
8149
|
-
*
|
|
8150
|
-
* This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.unified.FileUploaderParameter#constructor sap.ui.unified.FileUploaderParameter }
|
|
8151
|
-
* can be used.
|
|
8152
11277
|
*/
|
|
8153
11278
|
constructor(
|
|
8154
11279
|
/**
|
|
8155
11280
|
* initial settings for the new control
|
|
8156
11281
|
*/
|
|
8157
|
-
mSettings?: $
|
|
11282
|
+
mSettings?: $FileUploaderXHRSettingsSettings
|
|
8158
11283
|
);
|
|
8159
11284
|
/**
|
|
8160
|
-
* Constructor for a new
|
|
11285
|
+
* Constructor for a new FileUploaderXHRSettings.
|
|
8161
11286
|
*
|
|
8162
11287
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
8163
11288
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
8164
11289
|
* of the syntax of the settings object.
|
|
8165
|
-
*
|
|
8166
|
-
* This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.unified.FileUploaderParameter#constructor sap.ui.unified.FileUploaderParameter }
|
|
8167
|
-
* can be used.
|
|
8168
11290
|
*/
|
|
8169
11291
|
constructor(
|
|
8170
11292
|
/**
|
|
@@ -8174,14 +11296,14 @@ declare module "sap/ui/commons/FileUploaderParameter" {
|
|
|
8174
11296
|
/**
|
|
8175
11297
|
* initial settings for the new control
|
|
8176
11298
|
*/
|
|
8177
|
-
mSettings?: $
|
|
11299
|
+
mSettings?: $FileUploaderXHRSettingsSettings
|
|
8178
11300
|
);
|
|
8179
11301
|
|
|
8180
11302
|
/**
|
|
8181
|
-
* Creates a new subclass of class sap.ui.commons.
|
|
11303
|
+
* Creates a new subclass of class sap.ui.commons.FileUploaderXHRSettings with name `sClassName` and enriches
|
|
8182
11304
|
* it with the information contained in `oClassInfo`.
|
|
8183
11305
|
*
|
|
8184
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.
|
|
11306
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
8185
11307
|
*
|
|
8186
11308
|
*
|
|
8187
11309
|
* @returns Created class / constructor function
|
|
@@ -8194,7 +11316,7 @@ declare module "sap/ui/commons/FileUploaderParameter" {
|
|
|
8194
11316
|
/**
|
|
8195
11317
|
* Object literal with information about the class
|
|
8196
11318
|
*/
|
|
8197
|
-
oClassInfo?: sap.ClassInfo<T,
|
|
11319
|
+
oClassInfo?: sap.ClassInfo<T, FileUploaderXHRSettings>,
|
|
8198
11320
|
/**
|
|
8199
11321
|
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
8200
11322
|
* used by this class
|
|
@@ -8202,21 +11324,58 @@ declare module "sap/ui/commons/FileUploaderParameter" {
|
|
|
8202
11324
|
FNMetaImpl?: Function
|
|
8203
11325
|
): Function;
|
|
8204
11326
|
/**
|
|
8205
|
-
* Returns a metadata object for class sap.ui.commons.
|
|
11327
|
+
* Returns a metadata object for class sap.ui.commons.FileUploaderXHRSettings.
|
|
8206
11328
|
*
|
|
8207
11329
|
*
|
|
8208
11330
|
* @returns Metadata object describing this class
|
|
8209
11331
|
*/
|
|
8210
11332
|
static getMetadata(): ElementMetadata;
|
|
11333
|
+
/**
|
|
11334
|
+
* Gets current value of property {@link #getWithCredentials withCredentials}.
|
|
11335
|
+
*
|
|
11336
|
+
* Determines the value of the `XMLHttpRequest.withCredentials` property
|
|
11337
|
+
*
|
|
11338
|
+
* Default value is `false`.
|
|
11339
|
+
*
|
|
11340
|
+
* @since 1.52
|
|
11341
|
+
*
|
|
11342
|
+
* @returns Value of property `withCredentials`
|
|
11343
|
+
*/
|
|
11344
|
+
getWithCredentials(): boolean;
|
|
11345
|
+
/**
|
|
11346
|
+
* Sets a new value for property {@link #getWithCredentials withCredentials}.
|
|
11347
|
+
*
|
|
11348
|
+
* Determines the value of the `XMLHttpRequest.withCredentials` property
|
|
11349
|
+
*
|
|
11350
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
11351
|
+
*
|
|
11352
|
+
* Default value is `false`.
|
|
11353
|
+
*
|
|
11354
|
+
* @since 1.52
|
|
11355
|
+
*
|
|
11356
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11357
|
+
*/
|
|
11358
|
+
setWithCredentials(
|
|
11359
|
+
/**
|
|
11360
|
+
* New value for property `withCredentials`
|
|
11361
|
+
*/
|
|
11362
|
+
bWithCredentials?: boolean
|
|
11363
|
+
): this;
|
|
8211
11364
|
}
|
|
8212
11365
|
/**
|
|
8213
|
-
* Describes the settings that can be provided to the
|
|
11366
|
+
* Describes the settings that can be provided to the FileUploaderXHRSettings constructor.
|
|
8214
11367
|
*
|
|
8215
|
-
* @deprecated As of version 1.
|
|
11368
|
+
* @deprecated As of version 1.144.0. Please use the control sap.ui.unified.FileUploaderXHRSettings of the
|
|
8216
11369
|
* library sap.ui.unified instead.
|
|
8217
11370
|
*/
|
|
8218
|
-
export interface $
|
|
8219
|
-
|
|
11371
|
+
export interface $FileUploaderXHRSettingsSettings extends $ElementSettings {
|
|
11372
|
+
/**
|
|
11373
|
+
* Determines the value of the `XMLHttpRequest.withCredentials` property
|
|
11374
|
+
*
|
|
11375
|
+
* @since 1.52
|
|
11376
|
+
*/
|
|
11377
|
+
withCredentials?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
11378
|
+
}
|
|
8220
11379
|
}
|
|
8221
11380
|
|
|
8222
11381
|
declare module "sap/ui/commons/TextField" {
|
|
@@ -32571,8 +35730,12 @@ declare namespace sap {
|
|
|
32571
35730
|
|
|
32572
35731
|
"sap/ui/commons/FileUploader": undefined;
|
|
32573
35732
|
|
|
35733
|
+
"sap/ui/commons/FileUploaderHttpRequestMethod": undefined;
|
|
35734
|
+
|
|
32574
35735
|
"sap/ui/commons/FileUploaderParameter": undefined;
|
|
32575
35736
|
|
|
35737
|
+
"sap/ui/commons/FileUploaderXHRSettings": undefined;
|
|
35738
|
+
|
|
32576
35739
|
"sap/ui/commons/form/Form": undefined;
|
|
32577
35740
|
|
|
32578
35741
|
"sap/ui/commons/form/FormContainer": undefined;
|